Skip to content
Snippets Groups Projects
Commit 348d606c authored by Michael Zikeli's avatar Michael Zikeli
Browse files

Merge branch 'fhennig/documentation-update' into 'v2.0-dev'

Refactor and Improve Documentation

See merge request !425
parents f2d82bf0 69d25cec
Branches
1 merge request!425Refactor and Improve Documentation
Pipeline #70359 passed with stages
in 2 minutes and 30 seconds
Showing
with 12 additions and 2452 deletions
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
API Reference
=============
.. toctree::
:maxdepth: 3
kernel_compile_and_call.rst
enums.rst
simplifications.rst
datahandling.rst
configuration.rst
field.rst
stencil.rst
finite_differences.rst
plot.rst
ast.rst
*********************************************
For developers: AST Nodes and Transformations
*********************************************
AST Nodes
=========
.. automodule:: pystencils.astnodes
:members:
Transformations
===============
.. automodule:: pystencils.transformations
:members:
*************
Configuration
*************
.. automodule:: pystencils.cpu.cpujit
\ No newline at end of file
************
DataHandling
************
.. autoclass:: pystencils.datahandling.DataHandling
:members:
\ No newline at end of file
************
Enumerations
************
.. automodule:: pystencils.enums
:members:
*****
Field
*****
.. automodule:: pystencils.field
:members:
\ No newline at end of file
******************
Finite Differences
******************
.. automodule:: pystencils.fd
:members:
*****************************************
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:
**********************
Plotting and Animation
**********************
.. automodule:: pystencils.plot
:members:
This diff is collapsed.
*******
Stencil
*******
.. automodule:: pystencils.stencil
:members:
This diff is collapsed.
build build
# sphinx.ext.autosummary generated files
**/autoapi
table.docutils {
width: 100%;
}
This diff is collapsed.
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment