From 82fae6e53ae64772d046ca7ddba3a16a9c6183d4 Mon Sep 17 00:00:00 2001 From: Christian Date: Mon, 24 Apr 2017 10:12:17 +0100 Subject: [PATCH] first framework split from none version --- .gitignore | 3 + doc/Makefile | 20 + doc/doc_requirements.txt | 15 + doc/make.bat | 36 ++ doc/source/_static/.gitignore | 0 doc/source/conf.py | 371 ++++++++++++++++++ doc/source/data_specification_index.rst | 19 + doc/source/index.rst | 224 +++++++++++ doc/source/pacman_index.rst | 19 + doc/source/spinn_front_end_common_index.rst | 19 + doc/source/spinn_machine_index.rst | 20 + doc/source/spinn_storage_handlers_index.rst | 19 + doc/source/spinn_utilities_index.rst | 20 + .../spinnaker_graph_front_end_index.rst | 19 + doc/source/spinnman_index.rst | 19 + ...pynnaker_external_devices_plugin_index.rst | 19 + .../spynnaker_extra_pynn_models_index.rst | 19 + doc/source/spynnaker_index.rst | 19 + 18 files changed, 880 insertions(+) create mode 100644 .gitignore create mode 100644 doc/Makefile create mode 100644 doc/doc_requirements.txt create mode 100644 doc/make.bat create mode 100644 doc/source/_static/.gitignore create mode 100644 doc/source/conf.py create mode 100644 doc/source/data_specification_index.rst create mode 100644 doc/source/index.rst create mode 100644 doc/source/pacman_index.rst create mode 100644 doc/source/spinn_front_end_common_index.rst create mode 100644 doc/source/spinn_machine_index.rst create mode 100644 doc/source/spinn_storage_handlers_index.rst create mode 100644 doc/source/spinn_utilities_index.rst create mode 100644 doc/source/spinnaker_graph_front_end_index.rst create mode 100644 doc/source/spinnman_index.rst create mode 100644 doc/source/spynnaker_external_devices_plugin_index.rst create mode 100644 doc/source/spynnaker_extra_pynn_models_index.rst create mode 100644 doc/source/spynnaker_index.rst diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..82a39da --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +/.settings +/.project +/.pydevproject diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000..18f9f61 --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = Spinnaker +SOURCEDIR = source +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/doc/doc_requirements.txt b/doc/doc_requirements.txt new file mode 100644 index 0000000..926c0c4 --- /dev/null +++ b/doc/doc_requirements.txt @@ -0,0 +1,15 @@ +six +enum34 +lxml +-e git+https://github.com/SpiNNakerManchester/SpiNNUtils.git@master#egg=spinn_utilities +-e git+https://github.com/SpiNNakerManchester/SpiNNMachine.git@master#egg=spinn_machine +-e git+https://github.com/SpiNNakerManchester/SpiNNStorageHandlers.git@master#egg=spinn_storage_handlers +-e git+https://github.com/SpiNNakerManchester/SpiNNMan.git@master#egg=spinnman +-e git+https://github.com/SpiNNakerManchester/PACMAN.git@master#egg=pacman +-e git+https://github.com/SpiNNakerManchester/DataSpecification.git@master#egg=data_specification +-e git+https://github.com/SpiNNakerManchester/spalloc.git@master#egg=spalloc +-e git+https://github.com/SpiNNakerManchester/SpiNNFrontEndCommon.git@master#egg=spinn_front_end_common +-e git+https://github.com/SpiNNakerManchester/SpiNNakerGraphFrontEnd.git@master#egg=spinnaker_graph_front_end +-e git+https://github.com/SpiNNakerManchester/sPyNNaker.git@master#egg=spynnaker +-e git+https://github.com/SpiNNakerManchester/sPyNNakerExternalDevicesPlugin.git@master#egg=spynnaker_external_devices_plugin +-e git+https://github.com/SpiNNakerManchester/sPyNNakerExtraModelsPlugin.git@master#egg=spynnaker_extra_pynn_models diff --git a/doc/make.bat b/doc/make.bat new file mode 100644 index 0000000..34b78b1 --- /dev/null +++ b/doc/make.bat @@ -0,0 +1,36 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build +set SPHINXPROJ=Spinnaker + +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/doc/source/_static/.gitignore b/doc/source/_static/.gitignore new file mode 100644 index 0000000..e69de29 diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 0000000..5c2c9cb --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,371 @@ +# -*- coding: utf-8 -*- +# +# data_allocation documentation build configuration file, created by +# sphinx-quickstart on Tue Jun 17 08:56:46 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. + +from sphinx import apidoc +import mock +import sys +import os + +# 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('.')) + +# -- 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 = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.viewcode', + 'sphinx.ext.autosummary', +] + +# 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' + +# General information about the project. +project = u'SpiNNakerManchester' +copyright = u'2014-2017' + +# 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 = '' +# The full version, including alpha/beta/rc tags. +release = '' + +# 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 = ['_build'] + +# 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 = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + + +# -- 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 = 'sphinxdoc' + +# 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 +# " v 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'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# html_extra_path = [] + +# 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 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 = 'SpiNNakerManchesterdoc' + + +# -- 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, or own class]). +latex_documents = [ + ('index', 'SpiNNakerManchester.tex', u'SpiNNakerManchester Documentation', + u'', '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 +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'SpiNNakerManchester', u'SpiNNakerManchester Documentation', + [u''], 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 +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'SpiNNakerManchester', u'SpiNNakerManchester Documentation', + u'', 'SpiNNakerManchester', '', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +# texinfo_appendices = [] + +# If false, no module index is generated. +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# texinfo_no_detailmenu = False + + +# -- Options for Epub output ---------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = u'SpiNNakerManchester' +epub_author = u'' +epub_publisher = u'' +epub_copyright = u'2017' + +# The basename for the epub file. It defaults to the project name. +# epub_basename = u'data_allocation' + +# The HTML theme for the epub output. +# Since the default themes are not optimized +# for small screen space, using the same theme for HTML and epub output is +# usually not wise. This defaults to 'epub', a theme designed to save visual +# space. +# epub_theme = 'epub' + +# The language of the text. It defaults to the language option +# or en if the language is not set. +# epub_language = '' + +# The scheme of the identifier. Typical schemes are ISBN or URL. +# epub_scheme = '' + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +# epub_identifier = '' + +# A unique identification for the text. +# epub_uid = '' + +# A tuple containing the cover image and cover page html template filenames. +# epub_cover = () + +# A sequence of (type, uri, title) tuples for the guide element of content.opf. +# epub_guide = () + +# HTML files that should be inserted before the pages created by sphinx. +# The format is a list of tuples containing the path and title. +# epub_pre_files = [] + +# HTML files shat should be inserted after the pages created by sphinx. +# The format is a list of tuples containing the path and title. +# epub_post_files = [] + +# A list of files that should not be packed into the epub file. +epub_exclude_files = ['search.html'] + +# The depth of the table of contents in toc.ncx. +# epub_tocdepth = 3 + +# Allow duplicate toc entries. +# epub_tocdup = True + +# Choose between 'default' and 'includehidden'. +# epub_tocscope = 'default' + +# Fix unsupported image types using the PIL. +# epub_fix_images = False + +# Scale large images. +# epub_max_image_width = 0 + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# epub_show_urls = 'inline' + +# If false, no index is generated. +# epub_use_index = True + +autoclass_content = 'both' + +autoclass_content = 'both' + +MOCK_MODULES = ['scipy', 'scipy.stats'] +for mod_name in MOCK_MODULES: + sys.modules[mod_name] = mock.Mock() + + +def list_module(module_name, exclude = None): + if os.path.exists(module_name): + for name in os.listdir(module_name): + path = os.path.join(module_name, name) + os.remove(path) + else: + os.mkdir(module_name) + module = __import__(module_name) + source = os.path.dirname(module.__file__) + if exclude == None: + apidoc.main([None, '-o', module_name, source]) + else: + exclude_path = os.path.join(source, exclude) + apidoc.main([None, '-o', module_name, source, exclude_path]) + +list_module("spinn_utilities") +list_module("spinn_machine") +list_module("spinn_storage_handlers") +list_module("spinnman") +list_module("pacman") +list_module("data_specification", "data_spec_sender") +list_module("spinn_front_end_common") +list_module("spinnaker_graph_front_end", "examples") +list_module("spynnaker") +list_module("spynnaker_external_devices_plugin") +list_module("spynnaker_extra_pynn_models") \ No newline at end of file diff --git a/doc/source/data_specification_index.rst b/doc/source/data_specification_index.rst new file mode 100644 index 0000000..7ed48d5 --- /dev/null +++ b/doc/source/data_specification_index.rst @@ -0,0 +1,19 @@ +DataSpecification +================= + +.. automodule:: data_specification + +Contents +-------- + +.. toctree:: + :maxdepth: 10 + + data_specification/modules.rst + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..b88742a --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,224 @@ +SpiNNaker Manchester (PyNN 8) +============================= +These pages document the main Manchester python code for the PyNN 8 branch of the SpiNNaker_ Project. + +.. _SpiNNaker: http://apt.cs.manchester.ac.uk/projects/SpiNNaker/ + +Note: These pages are currently under development + +SpiNNUtils +---------- +This provides basic utility functions and classes to other parts of SpiNNaker's tooling. Nothing in here knows anything about SpiNNaker functionality. + +.. toctree:: + :maxdepth: 3 + + spinn_utilities_index + +SpiNNUtils_github_ + +SpiNNUtils_individual_docs_ + +.. _SpiNNUtils_github: https://github.com/SpiNNakerManchester/SpiNNUtils +.. _SpiNNUtils_individual_docs: http://spinnutils.readthedocs.io + +SpiNNMachine +------------ +This package is used to provide a Python representation of a SpiNNaker machine + +.. toctree:: + :maxdepth: 3 + + spinn_machine_index + +SpiNNMachine_github_ + +SpiNNMachine_individual_docs_ + +.. _SpiNNMachine_github: https://github.com/SpiNNakerManchester/SpiNNMachine +.. _SpiNNMachine_individual_docs: http://spinnmachine.readthedocs.io + + +SpiNNStorageHandlers +-------------------- +This package provides classes to handle data storage, both in memory (through a bytearray buffer) and in a file. The file may be permanent or temporary. + +.. toctree:: + :maxdepth: 3 + + spinn_storage_handlers_index + +SpiNNStorageHandlers_github_ + +SpiNNStorageHandlers_individual_docs_ + +.. _SpiNNStorageHandlers_github: https://github.com/SpiNNakerManchester/SpiNNStorageHandlers +.. _SpiNNStorageHandlers_individual_docs: http://spinnstoragehandlers.readthedocs.io + + +PACMAN +------ +This package provides utilities for partitioning, placing a routing on a SpiNNaker machine + +.. toctree:: + :maxdepth: 3 + + pacman_index + +PACMAN_github_ + +PACMAN_individual_docs_ + +.. _PACMAN_github: https://github.com/SpiNNakerManchester/PACMAN +.. _PACMAN_individual_docs: http://pacman.readthedocs.io + + +SpiNNMan +-------- +This package provides utilities for interacting with a SpiNNaker machine. + +.. toctree:: + :maxdepth: 3 + + spinnman_index + +SpiNNMan_github_ + +SpiNNMan_individual_docs_ + +.. _SpiNNMan_github: https://github.com/SpiNNakerManchester/SpiNNMan +.. _SpiNNMan_individual_docs: http://spinnman.readthedocs.io + + +DataSpecification +----------------- +This package provides utilities for specifying binary data algorithmically, and executing the specifications to produce the data. + +.. toctree:: + :maxdepth: 3 + + data_specification_index + +DataSpecification_github_ + +DataSpecification_individual_docs_ + +.. _DataSpecification_github: https://github.com/SpiNNakerManchester/DataSpecification +.. _DataSpecification_individual_docs: http://dataspecification.readthedocs.io + +spalloc +------- +Spalloc is a Python library and set of command-line programs for requesting SpiNNaker machines from a spalloc server. + +The spalloc module uses a different documentation style so is not included here. + +Their documenation can be found at: spalloc_readthedocs_ + +spalloc_github_ + +.. _spalloc_github: https://github.com/SpiNNakerManchester/spalloc +.. _spalloc_readthedocs: http://spalloc.readthedocs.io + +SpiNNFrontEndCommon +------------------- +This package provides functionality which are common to front ends that translate application level programs into executables which run on a SpiNNaker machine. + +.. toctree:: + :maxdepth: 3 + + spinn_front_end_common_index + +SpiNNFrontEndCommon_github_ + +SpiNNFrontEndCommon_individual_docs_ + +.. _SpiNNFrontEndCommon_github: https://github.com/SpiNNakerManchester/SpiNNFrontEndCommon +.. _SpiNNFrontEndCommon_individual_docs: http://spinnfrontendcommon.readthedocs.io + + +SpiNNakerGraphFrontEnd +---------------------- + +.. toctree:: + :maxdepth: 3 + + spinnaker_graph_front_end_index + +SpiNNakerGraphFrontEnd_github_ + +SpiNNakerGraphFrontEnd_individual_docs_ + +.. _SpiNNakerGraphFrontEnd_github: https://github.com/SpiNNakerManchester/SpiNNakerGraphFrontEnd +.. _SpiNNakerGraphFrontEnd_individual_docs: http://spinnakergraphfrontend.readthedocs.io + + +sPyNNaker +--------- +This package provides a PyNN implementation for SpiNNaker. + +.. toctree:: + :maxdepth: 3 + + spynnaker_index + +sPyNNaker_github_ + +sPyNNaker_individual_docs_ + +.. _sPyNNaker_github: https://github.com/SpiNNakerManchester/sPyNNaker +.. _sPyNNaker_individual_docs: http://spynnaker.readthedocs.io + + +sPyNNakerExternalDevicesPlugin +------------------------------ + +.. toctree:: + :maxdepth: 3 + + spynnaker_external_devices_plugin_index + +sPyNNakerExternalDevicesPlugin_github_ + +sPyNNakerExternalDevicesPlugin_individual_docs_ + +.. _sPyNNakerExternalDevicesPlugin_github: https://github.com/SpiNNakerManchester/sPyNNakerExternalDevicesPlugin +.. _sPyNNakerExternalDevicesPlugin_individual_docs: http://spynnakerexternaldevicesplugin.readthedocs.io + + +sPyNNakerExtraModelsPlugin +-------------------------- + +This package provides implementations of other neural models which are currently not support by the PyNN language. + +.. toctree:: + :maxdepth: 3 + + spynnaker_extra_pynn_models_index + +sPyNNakerExtraModelsPlugin_github_ + +sPyNNakerExtraModelsPlugin_individual_docs_ + +.. _sPyNNakerExtraModelsPlugin_github: https://github.com/SpiNNakerManchester/sPyNNakerExtraModelsPlugin +.. _sPyNNakerExtraModelsPlugin_individual_docs: http://spynnakerextramodelsplugin.readthedocs.io + +spalloc_server +-------------- +A SpiNNaker machine management application which manages the partitioning and allocation of large SpiNNaker machines +into smaller fragments for many simultaneous users. + +The spalloc_server module uses a different documentation style so is not included here. + +Their documenation can be found at: spalloc_server_readthedocs_ + +spalloc_server_github_ + +.. _spalloc_server_github: https://github.com/SpiNNakerManchester/spalloc_server +.. _spalloc_server_readthedocs: http://spalloc-server.readthedocs.io + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/doc/source/pacman_index.rst b/doc/source/pacman_index.rst new file mode 100644 index 0000000..d2e4a8e --- /dev/null +++ b/doc/source/pacman_index.rst @@ -0,0 +1,19 @@ +PACMAN +====== + +.. automodule:: pacman + +Contents +-------- + +.. toctree:: + :maxdepth: 10 + + pacman/modules.rst + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/doc/source/spinn_front_end_common_index.rst b/doc/source/spinn_front_end_common_index.rst new file mode 100644 index 0000000..0248207 --- /dev/null +++ b/doc/source/spinn_front_end_common_index.rst @@ -0,0 +1,19 @@ +SpiNNFrontEndCommon +=================== + +.. automodule:: spinn_front_end_common + +Contents +-------- + +.. toctree:: + :maxdepth: 10 + + spinn_front_end_common/modules.rst + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/doc/source/spinn_machine_index.rst b/doc/source/spinn_machine_index.rst new file mode 100644 index 0000000..bf23d9f --- /dev/null +++ b/doc/source/spinn_machine_index.rst @@ -0,0 +1,20 @@ +SpiNNMachine +============ + +.. automodule:: spinn_machine + +Contents +-------- + +.. toctree:: + :maxdepth: 10 + + spinn_machine/modules.rst + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/doc/source/spinn_storage_handlers_index.rst b/doc/source/spinn_storage_handlers_index.rst new file mode 100644 index 0000000..cd5aab0 --- /dev/null +++ b/doc/source/spinn_storage_handlers_index.rst @@ -0,0 +1,19 @@ +SpiNNStorageHandlers +==================== + +.. automodule:: spinn_storage_handlers + +Contents +-------- + +.. toctree:: + :maxdepth: 10 + + spinn_storage_handlers/modules.rst + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/doc/source/spinn_utilities_index.rst b/doc/source/spinn_utilities_index.rst new file mode 100644 index 0000000..6c07dfb --- /dev/null +++ b/doc/source/spinn_utilities_index.rst @@ -0,0 +1,20 @@ +SpiNNUtils +========== + +.. automodule:: spinn_utilities + +Contents +-------- + +.. toctree:: + :maxdepth: 10 + + spinn_utilities/modules.rst + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/doc/source/spinnaker_graph_front_end_index.rst b/doc/source/spinnaker_graph_front_end_index.rst new file mode 100644 index 0000000..d287045 --- /dev/null +++ b/doc/source/spinnaker_graph_front_end_index.rst @@ -0,0 +1,19 @@ +SpiNNFrontEndCommon +=================== + +.. automodule:: spinnaker_graph_front_end + +Contents +-------- + +.. toctree:: + :maxdepth: 10 + + spinnaker_graph_front_end/modules.rst + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/doc/source/spinnman_index.rst b/doc/source/spinnman_index.rst new file mode 100644 index 0000000..2fb777d --- /dev/null +++ b/doc/source/spinnman_index.rst @@ -0,0 +1,19 @@ +SpiNNMan +======== + +.. automodule:: spinnman + +Contents +-------- + +.. toctree:: + :maxdepth: 10 + + spinnman/modules.rst + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/doc/source/spynnaker_external_devices_plugin_index.rst b/doc/source/spynnaker_external_devices_plugin_index.rst new file mode 100644 index 0000000..3c4c5e1 --- /dev/null +++ b/doc/source/spynnaker_external_devices_plugin_index.rst @@ -0,0 +1,19 @@ +sPyNNakerExternalDevicesPlugin +============================== + +.. automodule:: spynnaker_external_devices_plugin + +Contents +-------- + +.. toctree:: + :maxdepth: 10 + + spynnaker_external_devices_plugin/modules.rst + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/doc/source/spynnaker_extra_pynn_models_index.rst b/doc/source/spynnaker_extra_pynn_models_index.rst new file mode 100644 index 0000000..c4a1af0 --- /dev/null +++ b/doc/source/spynnaker_extra_pynn_models_index.rst @@ -0,0 +1,19 @@ +sPyNNakerExtraModelsPlugin +========================== + +.. automodule:: spynnaker_extra_pynn_models + +Contents +-------- + +.. toctree:: + :maxdepth: 10 + + spynnaker_extra_pynn_models/modules.rst + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/doc/source/spynnaker_index.rst b/doc/source/spynnaker_index.rst new file mode 100644 index 0000000..cff5327 --- /dev/null +++ b/doc/source/spynnaker_index.rst @@ -0,0 +1,19 @@ +sPyNNaker +========= + +.. automodule:: spynnaker + +Contents +-------- + +.. toctree:: + :maxdepth: 10 + + spynnaker/modules.rst + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search`