doc/sphinx/ast.rst

-*********************************************
-For developers: AST Nodes and Transformations
-*********************************************
-
-
-AST Nodes
-=========
-
-.. automodule:: pystencils.astnodes
-   :members:
-
-
-
-Transformations
-===============
-
-
-.. automodule:: pystencils.transformations
-   :members:

doc/sphinx/configuration.rst

-*************
-Configuration
-*************
-
-.. automodule:: pystencils.cpu.cpujit
\ No newline at end of file

doc/sphinx/datahandling.rst

-************
-DataHandling
-************
-
-.. autoclass:: pystencils.datahandling.DataHandling
-   :members:
\ No newline at end of file

doc/sphinx/enums.rst

-************
-Enumerations
-************
-
-.. automodule:: pystencils.enums
-   :members:

doc/sphinx/field.rst

-*****
-Field
-*****
-
-.. automodule:: pystencils.field
-   :members:
\ No newline at end of file

doc/sphinx/finite_differences.rst

-******************
-Finite Differences
-******************
-
-.. automodule:: pystencils.fd
-   :members:
-

doc/sphinx/kernel_compile_and_call.rst

-*****************************************
-Creating and calling kernels from Python
-*****************************************
-
-
-Creating kernels
-----------------
-
-.. autofunction:: pystencils.create_kernel
-
-.. autoclass:: pystencils.CreateKernelConfig
-    :members:
-
-.. autofunction:: pystencils.kernelcreation.create_domain_kernel
-
-.. autofunction:: pystencils.kernelcreation.create_indexed_kernel
-
-.. autofunction:: pystencils.kernelcreation.create_staggered_kernel
-
-
-Code printing
--------------
-
-.. autofunction:: pystencils.show_code
-
-
-GPU Indexing
--------------
-
-.. autoclass:: pystencils.gpu.AbstractIndexing
-   :members:
-
-.. autoclass:: pystencils.gpu.BlockIndexing
-   :members:
-
-.. autoclass:: pystencils.gpu.LineIndexing
-   :members:

doc/sphinx/plot.rst

-**********************
-Plotting and Animation
-**********************
-
-.. automodule:: pystencils.plot
-   :members:
-
-

doc/sphinx/simplifications.rst

-***************************************
-Assignment Collection & Simplifications
-***************************************
-
-
-AssignmentCollection
-====================
-
-.. autoclass:: pystencils.AssignmentCollection
-   :members:
-
-
-SimplificationStrategy
-======================
-
-.. autoclass:: pystencils.simp.SimplificationStrategy
-    :members:
-
-Simplifications
-===============
-
-.. automodule:: pystencils.simp.simplifications
-    :members:
-
-Subexpression insertion
-=======================
-
-The subexpression insertions have the goal to insert subexpressions which will not reduce the number of FLOPs.
-For example a constant value kept as subexpression will lead to a new variable in the code which will occupy
-a register slot. On the other side a single variable could just be inserted in all assignments.
-
-.. automodule:: pystencils.simp.subexpression_insertion
-    :members:
-
-
-
-
-

doc/sphinx/stencil.rst

-*******
-Stencil
-*******
-
-.. automodule:: pystencils.stencil
-   :members:

docs/.gitignore

+build
+
+#   sphinx.ext.autosummary generated files
+**/generated

docs/Makefile

+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+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 html clean
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+# %: Makefile
+
+html:
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+clean:
+	rm -rf source/api/generated
+	rm -rf source/api/symbolic/generated
+	rm -rf source/backend/generated
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
\ No newline at end of file

docs/make.bat

+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%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.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/_static/css/fixtables.css

+table.docutils {
+    width: 100%;
+}