diff options
Diffstat (limited to 'demo')
| -rw-r--r-- | demo/doit/docs/.gitignore | 1 | ||||
| -rw-r--r-- | demo/doit/docs/Makefile | 20 | ||||
| -rw-r--r-- | demo/doit/docs/conf.py | 155 | ||||
| -rw-r--r-- | demo/doit/docs/index.rst | 24 | ||||
| -rw-r--r-- | demo/doit/docs/make.bat | 36 | ||||
| -rw-r--r-- | demo/doit/docs/report/index.rst | 4 | ||||
| -rw-r--r-- | demo/doit/docs/report/messages.rst | 5 | ||||
| -rw-r--r-- | demo/doit/dodo.py | 13 |
8 files changed, 257 insertions, 1 deletions
diff --git a/demo/doit/docs/.gitignore b/demo/doit/docs/.gitignore new file mode 100644 index 0000000..e35d885 --- /dev/null +++ b/demo/doit/docs/.gitignore @@ -0,0 +1 @@ +_build diff --git a/demo/doit/docs/Makefile b/demo/doit/docs/Makefile new file mode 100644 index 0000000..a7ef341 --- /dev/null +++ b/demo/doit/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = Demo +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
\ No newline at end of file diff --git a/demo/doit/docs/conf.py b/demo/doit/docs/conf.py new file mode 100644 index 0000000..4c45eca --- /dev/null +++ b/demo/doit/docs/conf.py @@ -0,0 +1,155 @@ +# -*- coding: utf-8 -*- +# +# Configuration file for the Sphinx documentation builder. +# +# This file does only contain a selection of the most common options. For a +# full list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = 'Demo' +copyright = '2018, Demo' +author = 'Demo' + +# The short X.Y version +version = '' +# The full version, including alpha/beta/rc tags +release = '' + + +# -- General configuration --------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path . +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# The default sidebars (for documents that don't match any pattern) are +# defined by theme itself. Builtin themes are using these templates by +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', +# 'searchbox.html']``. +# +# html_sidebars = {} + + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Demodoc' + + +# -- Options for LaTeX output ------------------------------------------------ + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'Demo.tex', 'Demo Documentation', + 'Demo', 'manual'), +] + + +# -- Options for manual page output ------------------------------------------ + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'demo', 'Demo Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ---------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'Demo', 'Demo Documentation', + author, 'Demo', 'One line description of project.', + 'Miscellaneous'), +]
\ No newline at end of file diff --git a/demo/doit/docs/index.rst b/demo/doit/docs/index.rst new file mode 100644 index 0000000..437a1e5 --- /dev/null +++ b/demo/doit/docs/index.rst @@ -0,0 +1,24 @@ +.. Demo documentation master file, created by + sphinx-quickstart on Sun Aug 5 12:49:19 2018. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Demo's documentation! +================================ + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + :numbered: + + report/index + report/messages + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/demo/doit/docs/make.bat b/demo/doit/docs/make.bat new file mode 100644 index 0000000..f8072c5 --- /dev/null +++ b/demo/doit/docs/make.bat @@ -0,0 +1,36 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build +set SPHINXPROJ=Demo + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% + +:end +popd diff --git a/demo/doit/docs/report/index.rst b/demo/doit/docs/report/index.rst new file mode 100644 index 0000000..98b460a --- /dev/null +++ b/demo/doit/docs/report/index.rst @@ -0,0 +1,4 @@ +Reports +------- + +* :doc:`messages` diff --git a/demo/doit/docs/report/messages.rst b/demo/doit/docs/report/messages.rst new file mode 100644 index 0000000..d2c6bd2 --- /dev/null +++ b/demo/doit/docs/report/messages.rst @@ -0,0 +1,5 @@ +Messages +-------- + +There are 0 messages. + diff --git a/demo/doit/dodo.py b/demo/doit/dodo.py index 780f2b9..74b621b 100644 --- a/demo/doit/dodo.py +++ b/demo/doit/dodo.py @@ -1,8 +1,10 @@ from ee.bom.doit import * from ee.digikey.doit import * -from ee.doit import configure_logging +from ee.doit import configure_logging, ReportCollection from ee.ds import DataSetManager from ee.kicad.doit import * +# noinspection PyUnresolvedReferences +from ee.report.doit import * def configure_kicad(): @@ -22,6 +24,11 @@ def configure_digikey(): doit_config.configure(data_set_manager=dsm) +def configure_report(): + from ee.report.doit import doit_config + doit_config.configure(data_set_manager=dsm, report_collection=report_collection, extra_config=extra_config) + + # Configure DoIt configure_logging() @@ -31,7 +38,10 @@ prj = "demo" sch = "{}.sch".format(prj) kicad_pcb = "{}.kicad_pcb".format(prj) +extra_config = dict(report_dir="docs/report") + dsm = DataSetManager("ee") +report_collection = ReportCollection() kicad_footprint = "kicad-footprint" dsm.register_ds("csv", kicad_footprint, "kicad-footprint-mapping", path="ee/kicad-footprint.csv") @@ -39,6 +49,7 @@ dsm.register_ds("csv", kicad_footprint, "kicad-footprint-mapping", path="ee/kica configure_kicad() configure_bom() configure_digikey() +configure_report() def task_orders(): |