From 3182652cb5c540c7c76786675729a6c7dc2b7f98 Mon Sep 17 00:00:00 2001
From: Frederik Hennig <frederik.hennig@fau.de>
Date: Fri, 18 Oct 2024 09:29:38 +0200
Subject: [PATCH] Update documentation
- use pystencils 2.0 intersphinx
- add doc for composer builders, SfgException, config subobjects
---
docs/source/api/composer.rst | 20 +++++++++++++++-----
docs/source/api/errors.rst | 6 ++++++
docs/source/api/generation.rst | 6 ++++++
docs/source/api/index.rst | 1 +
docs/source/conf.py | 1 +
5 files changed, 29 insertions(+), 5 deletions(-)
create mode 100644 docs/source/api/errors.rst
diff --git a/docs/source/api/composer.rst b/docs/source/api/composer.rst
index fb63d68..a969d4f 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 0000000..c793641
--- /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 45065c1..f15b117 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 681b6e8..1ea987f 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 11d64fd..3b7b20c 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),
}
--
GitLab