Skip to content
Snippets Groups Projects
Commit 3182652c authored by Frederik Hennig's avatar Frederik Hennig
Browse files

Update documentation

 - use pystencils 2.0 intersphinx
 - add doc for composer builders, SfgException, config subobjects
parent fbd9d9b4
Branches
Tags
No related merge requests found
......@@ -14,13 +14,23 @@ Composer API (`pystencilssfg.composer`)
.. autoclass:: pystencilssfg.composer.SfgClassComposer
:members:
Helper Methods
==============
.. autofunction:: pystencilssfg.composer.make_sequence
Custom Generators
=================
.. autoclass:: pystencilssfg.composer.custom.CustomGenerator
:members:
Helper Methods and Builders
===========================
.. autofunction:: pystencilssfg.composer.make_sequence
.. autoclass:: pystencilssfg.composer.basic_composer.SfgNodeBuilder
:members:
.. autoclass:: pystencilssfg.composer.basic_composer.SfgBranchBuilder
:members:
.. autoclass:: pystencilssfg.composer.basic_composer.SfgSwitchBuilder
:members:
*********************
Errors and Exceptions
*********************
.. automodule:: pystencilssfg.exceptions
:members:
......@@ -8,4 +8,10 @@ Generator Script Interface
.. autoclass:: pystencilssfg.SfgConfiguration
:members:
.. autoclass:: pystencilssfg.SfgOutputMode
:members:
.. autoclass:: pystencilssfg.SfgCodeStyle
:members:
.. autoattribute:: pystencilssfg.configuration.DEFAULT_CONFIG
......@@ -11,3 +11,4 @@ These pages provide a reference for the public API of *pystencils-sfg*.
composer
lang
ir
errors
......@@ -57,6 +57,7 @@ intersphinx_mapping = {
"numpy": ("https://docs.scipy.org/doc/numpy/", None),
"matplotlib": ("https://matplotlib.org/", None),
"sympy": ("https://docs.sympy.org/latest/", None),
"pystencils": ("https://da15siwa.pages.i10git.cs.fau.de/dev-docs/pystencils-nbackend/", None),
}
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment