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

start rebuilding the documentation

parent 103553f4
Branches
Tags
No related merge requests found
Pipeline #64127 failed
Showing
with 158 additions and 28 deletions
***********************
Expression Manipulation
***********************
Variables and Constants
=======================
.. automodule:: pystencils.nbackend.typed_expressions
:members:
Functions
=========
.. automodule:: pystencils.nbackend.functions
:members:
***************
The Type System
***************
.. automodule:: pystencils.nbackend.types
:members:
build
# 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 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)
@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/img/logo.png

9.88 KiB

#############
API Reference
#############
.. toctree::
:maxdepth: 2
sympyextensions/index
kernelcreation/index
types/index
***************
Kernel Creation
***************
The primary interface for creating numerical kernels in pystencils is the function `create_kernel`.
.. autoclass:: pystencils.CreateKernelConfig
:members:
.. autofunction:: pystencils.create_kernel
.. autoclass:: pystencils.backend.KernelFunction
:members:
----------------
Kernel Structure
----------------
.. automodule:: pystencils.sympyextensions.astnodes
.. autoclass:: pystencils.sympyextensions.AssignmentCollection
:members:
-------------------------
Fields (pystencils.field)
-------------------------
.. automodule:: pystencils.field
:members:
.. autoclass:: pystencils.sympyextensions.ConditionalFieldAccess
:members:
*****************
Symbolic Language
*****************
.. toctree::
:maxdepth: 1
field
astnodes
Data Type Class Hierarchy
-------------------------
.. automodule:: pystencils.types.basic_types
:members:
**********
Data Types
**********
Type System Module (pystencils.types)
-------------------------------------
.. automodule:: pystencils.types
.. autofunction:: pystencils.types.create_type
.. autofunction:: pystencils.types.create_numeric_type
.. toctree::
:maxdepth: 1
basic_types
quick
Data Type Abbreviations
-----------------------
.. automodule:: pystencils.types.quick
:members:
\ No newline at end of file
......@@ -2,5 +2,5 @@
Arrays
******
.. automodule:: pystencils.nbackend.arrays
.. automodule:: pystencils.backend.arrays
:members:
......@@ -2,5 +2,8 @@
Abstract Syntax Tree
********************
.. automodule:: pystencils.nbackend.ast
.. automodule:: pystencils.backend.ast.structural
:members:
.. automodule:: pystencils.backend.ast.expressions
:members:
#############################################################
Developer's Reference: Code Generation Backend (``nbackend``)
#############################################################
##############################################
Developer's Reference: Code Generation Backend
##############################################
These pages provide a detailed overview of the next-gen code generation backend ``nbackend`` currently being
......@@ -11,8 +11,6 @@ all code generation functionality currently implemented in *pystencils* version
:maxdepth: 1
rationale
type_system
expressions
arrays
ast
kernelcreation
......
......@@ -2,5 +2,5 @@
Just-In-Time Compilation
************************
.. automodule:: pystencils.nbackend.jit
.. automodule:: pystencils.backend.jit
:members:
......@@ -2,5 +2,5 @@
Kernel Creation
***************
.. automodule:: pystencils.nbackend.kernelcreation
.. automodule:: pystencils.kernelcreation
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment