diff --git a/hbp_nrp_virtual_coach/doc/.gitignore b/hbp_nrp_virtual_coach/doc/.gitignore new file mode 100644 index 0000000000000000000000000000000000000000..6a25ca078607a36b5aaf50fbfff50b5f3d05f264 --- /dev/null +++ b/hbp_nrp_virtual_coach/doc/.gitignore @@ -0,0 +1,2 @@ +source/apidoc +build \ No newline at end of file diff --git a/hbp_nrp_virtual_coach/doc/Makefile b/hbp_nrp_virtual_coach/doc/Makefile index 81dde8b5e7bfd7cafe74e5fe115ecdd7fd9dcab3..cc83591d17def88914c783c923f5498caa87f166 100644 --- a/hbp_nrp_virtual_coach/doc/Makefile +++ b/hbp_nrp_virtual_coach/doc/Makefile @@ -40,6 +40,7 @@ help: clean: -rm -rf $(BUILDDIR)/* + -rm -rf source/apidoc html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html diff --git a/hbp_nrp_virtual_coach/doc/source/conf.py b/hbp_nrp_virtual_coach/doc/source/conf.py index aaf67aea14fed5b2c8bf8cc695dbaef5eed5da73..7134af96ff94c046058f2a4e6a508dd676360172 100644 --- a/hbp_nrp_virtual_coach/doc/source/conf.py +++ b/hbp_nrp_virtual_coach/doc/source/conf.py @@ -22,216 +22,29 @@ # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. # ---LICENSE-END # -*- coding: utf-8 -*- -# -# python_skeleton documentation build configuration file, created by -# sphinx-quickstart on Wed Jan 29 14:44:00 2014. -# -# This file is execfile()d with the current directory set to its containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. import sys, os -import pynrp +# import conf.py from admin-scripts +sys.path.insert(0, os.environ.get('HBP') + '/admin-scripts/ContinuousIntegration/python/docs') +from sphinxconf import * # pylint: disable=import-error -# 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. -#sys.path.insert(0, os.path.abspath('.')) +# import modules needed by this project +sys.path.insert(0, os.path.abspath('../../pynrp')) # Source code dir relative to this file +import pynrp # -- General configuration ----------------------------------------------------- +# Add any Sphinx extension module names here, as strings. +# The common extensions are defined in admin-scripts +# extensions = [] -# 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 = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode'] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -#source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'index' +apidoc_module_dir = '../../pynrp' # General information about the project. project = u'Virtual Coach' -copyright = u'2017 Human Brain Project. All rights reserved.' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = pynrp.__version__ -# The full version, including alpha/beta/rc tags. -release = pynrp.__version__ - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = [] - -# The reST default role (used for this markup: `text`) to use for all documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - - -# -- 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 = 'haiku' - -# 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 themes here, relative to this directory. -#html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# "<project> v<release> documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - -# 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'] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_domain_indices = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a <link> tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = 'pynrp_doc' - -# -- 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': '', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). -latex_documents = [ - ('index', 'pynrp.tex', u'Virtual Coach Documentation', - u'Human Brain Project', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - - # -- Options for manual page output -------------------------------------------- # One entry per manual page. List of tuples @@ -241,10 +54,6 @@ man_pages = [ [u'Sharma', u'Akl'], 1) ] -# If true, show URL addresses after external links. -#man_show_urls = False - - # -- Options for Texinfo output ------------------------------------------------ # Grouping the document tree into Texinfo files. List of tuples @@ -256,11 +65,9 @@ texinfo_documents = [ 'Miscellaneous'), ] -# Documents to append as an appendix to all manuals. -#texinfo_appendices = [] +# -- Mocking for importing external modules ------------------------------------ + +# the following modules are part of CLE and should be mocked in the ExDBackend +autodoc_mock_imports = ['pyNN.nest', 'nest'] -# If false, no module index is generated. -#texinfo_domain_indices = True -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' diff --git a/hbp_nrp_virtual_coach/doc/source/hbp_nrp_virtual_coach.rst b/hbp_nrp_virtual_coach/doc/source/hbp_nrp_virtual_coach.rst deleted file mode 100644 index 32d7323c53500c1b5a096b7399aca4f2fa2144b4..0000000000000000000000000000000000000000 --- a/hbp_nrp_virtual_coach/doc/source/hbp_nrp_virtual_coach.rst +++ /dev/null @@ -1,7 +0,0 @@ -*************** -Python API -*************** - -.. toctree:: - - pynrp.virtual_coach diff --git a/hbp_nrp_virtual_coach/doc/source/hbp_nrp_virtual_coach.virtual_coach.rst b/hbp_nrp_virtual_coach/doc/source/hbp_nrp_virtual_coach.virtual_coach.rst deleted file mode 100644 index fabe7647ac573498a898a9d49d12c0a059d88e6d..0000000000000000000000000000000000000000 --- a/hbp_nrp_virtual_coach/doc/source/hbp_nrp_virtual_coach.virtual_coach.rst +++ /dev/null @@ -1,23 +0,0 @@ -Virtual Coach -============= - -.. automodule:: pynrp - :members: - :undoc-members: - :show-inheritance: - -:mod:`VirtualCoach` Module --------------------------- - -.. automodule:: pynrp.virtual_coach - :members: - :undoc-members: - :show-inheritance: - -:mod:`Simulation` Module ------------------------- - -.. automodule:: pynrp.simulation - :members: - :undoc-members: - :show-inheritance: diff --git a/hbp_nrp_virtual_coach/doc/source/index.rst b/hbp_nrp_virtual_coach/doc/source/index.rst index 892c3cfced85b75a30b018fad17828395e08432a..35a3865992b8a0c1733a6e55133ad9c7bb9c82bb 100644 --- a/hbp_nrp_virtual_coach/doc/source/index.rst +++ b/hbp_nrp_virtual_coach/doc/source/index.rst @@ -1,10 +1,9 @@ -.. python_skeleton documentation master file, created by - sphinx-quickstart on Wed Jan 29 14:44:00 2014. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. +.. _hbp_nrp_virtual_coach_docs: + +Virtual Coach +============= Welcome to the Virtual Coach documentation! -=========================================== Contents: @@ -12,13 +11,6 @@ Contents: :maxdepth: 2 introduction - pynrp - - -Indices and tables -================== + python_api -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/hbp_nrp_virtual_coach/doc/source/python_api.rst b/hbp_nrp_virtual_coach/doc/source/python_api.rst new file mode 100644 index 0000000000000000000000000000000000000000..745a4151aa798b0d51420ace83fda286e2b85d16 --- /dev/null +++ b/hbp_nrp_virtual_coach/doc/source/python_api.rst @@ -0,0 +1,7 @@ +Python developer API +==================== + +.. toctree:: + :maxdepth: 4 + + apidoc/pynrp \ No newline at end of file