diff --git a/docs/source/api/composer.rst b/docs/source/api/composer.rst index fb63d6811bac4935a15a8edcf7298423ea767ca1..a969d4ff91455f0fda51813aab93e23c4b0b7098 100644 --- a/docs/source/api/composer.rst +++ b/docs/source/api/composer.rst @@ -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: diff --git a/docs/source/api/errors.rst b/docs/source/api/errors.rst new file mode 100644 index 0000000000000000000000000000000000000000..c793641baaf03069c32761f47e0df33e70afeb09 --- /dev/null +++ b/docs/source/api/errors.rst @@ -0,0 +1,6 @@ +********************* +Errors and Exceptions +********************* + +.. automodule:: pystencilssfg.exceptions + :members: diff --git a/docs/source/api/generation.rst b/docs/source/api/generation.rst index 45065c13edc444239e928ecb66a376bc700e7959..f15b1170099cfb10c9f333cb6f4540137e162654 100644 --- a/docs/source/api/generation.rst +++ b/docs/source/api/generation.rst @@ -8,4 +8,10 @@ Generator Script Interface .. autoclass:: pystencilssfg.SfgConfiguration :members: +.. autoclass:: pystencilssfg.SfgOutputMode + :members: + +.. autoclass:: pystencilssfg.SfgCodeStyle + :members: + .. autoattribute:: pystencilssfg.configuration.DEFAULT_CONFIG diff --git a/docs/source/api/index.rst b/docs/source/api/index.rst index 681b6e851fffa26d94785dbdd71765953d6ba343..1ea987fdc32cc22a18c423c970d7bdfd0c8ca0cc 100644 --- a/docs/source/api/index.rst +++ b/docs/source/api/index.rst @@ -11,3 +11,4 @@ These pages provide a reference for the public API of *pystencils-sfg*. composer lang ir + errors diff --git a/docs/source/conf.py b/docs/source/conf.py index 11d64fd5a142eab3f1558c52944b772f94a5f266..3b7b20cc1efcd8d281bc18446dd7cd0aa08e3a37 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -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), }