Skip to content

Commit

Permalink
Add api doc.
Browse files Browse the repository at this point in the history
  • Loading branch information
garth-wells committed Nov 3, 2015
1 parent 8edc73d commit b7724a2
Show file tree
Hide file tree
Showing 8 changed files with 1,013 additions and 0 deletions.
7 changes: 7 additions & 0 deletions doc/sphinx/source/api-doc/modules.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ufl
===

.. toctree::
:maxdepth: 4

ufl
270 changes: 270 additions & 0 deletions doc/sphinx/source/api-doc/ufl.algorithms.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,270 @@
ufl.algorithms package
======================

Submodules
----------

ufl.algorithms.ad module
------------------------

.. automodule:: ufl.algorithms.ad
:members:
:undoc-members:
:show-inheritance:

ufl.algorithms.analysis module
------------------------------

.. automodule:: ufl.algorithms.analysis
:members:
:undoc-members:
:show-inheritance:

ufl.algorithms.apply_algebra_lowering module
--------------------------------------------

.. automodule:: ufl.algorithms.apply_algebra_lowering
:members:
:undoc-members:
:show-inheritance:

ufl.algorithms.apply_derivatives module
---------------------------------------

.. automodule:: ufl.algorithms.apply_derivatives
:members:
:undoc-members:
:show-inheritance:

ufl.algorithms.apply_function_pullbacks module
----------------------------------------------

.. automodule:: ufl.algorithms.apply_function_pullbacks
:members:
:undoc-members:
:show-inheritance:

ufl.algorithms.apply_geometry_lowering module
---------------------------------------------

.. automodule:: ufl.algorithms.apply_geometry_lowering
:members:
:undoc-members:
:show-inheritance:

ufl.algorithms.apply_integral_scaling module
--------------------------------------------

.. automodule:: ufl.algorithms.apply_integral_scaling
:members:
:undoc-members:
:show-inheritance:

ufl.algorithms.apply_restrictions module
----------------------------------------

.. automodule:: ufl.algorithms.apply_restrictions
:members:
:undoc-members:
:show-inheritance:

ufl.algorithms.argument_dependencies module
-------------------------------------------

.. automodule:: ufl.algorithms.argument_dependencies
:members:
:undoc-members:
:show-inheritance:

ufl.algorithms.change_to_reference module
-----------------------------------------

.. automodule:: ufl.algorithms.change_to_reference
:members:
:undoc-members:
:show-inheritance:

ufl.algorithms.check_arities module
-----------------------------------

.. automodule:: ufl.algorithms.check_arities
:members:
:undoc-members:
:show-inheritance:

ufl.algorithms.check_restrictions module
----------------------------------------

.. automodule:: ufl.algorithms.check_restrictions
:members:
:undoc-members:
:show-inheritance:

ufl.algorithms.checks module
----------------------------

.. automodule:: ufl.algorithms.checks
:members:
:undoc-members:
:show-inheritance:

ufl.algorithms.compute_form_data module
---------------------------------------

.. automodule:: ufl.algorithms.compute_form_data
:members:
:undoc-members:
:show-inheritance:

ufl.algorithms.domain_analysis module
-------------------------------------

.. automodule:: ufl.algorithms.domain_analysis
:members:
:undoc-members:
:show-inheritance:

ufl.algorithms.elementtransformations module
--------------------------------------------

.. automodule:: ufl.algorithms.elementtransformations
:members:
:undoc-members:
:show-inheritance:

ufl.algorithms.estimate_degrees module
--------------------------------------

.. automodule:: ufl.algorithms.estimate_degrees
:members:
:undoc-members:
:show-inheritance:

ufl.algorithms.expand_compounds module
--------------------------------------

.. automodule:: ufl.algorithms.expand_compounds
:members:
:undoc-members:
:show-inheritance:

ufl.algorithms.expand_indices module
------------------------------------

.. automodule:: ufl.algorithms.expand_indices
:members:
:undoc-members:
:show-inheritance:

ufl.algorithms.formdata module
------------------------------

.. automodule:: ufl.algorithms.formdata
:members:
:undoc-members:
:show-inheritance:

ufl.algorithms.formfiles module
-------------------------------

.. automodule:: ufl.algorithms.formfiles
:members:
:undoc-members:
:show-inheritance:

ufl.algorithms.formtransformations module
-----------------------------------------

.. automodule:: ufl.algorithms.formtransformations
:members:
:undoc-members:
:show-inheritance:

ufl.algorithms.forward_ad module
--------------------------------

.. automodule:: ufl.algorithms.forward_ad
:members:
:undoc-members:
:show-inheritance:

ufl.algorithms.map_integrands module
------------------------------------

.. automodule:: ufl.algorithms.map_integrands
:members:
:undoc-members:
:show-inheritance:

ufl.algorithms.multifunction module
-----------------------------------

.. automodule:: ufl.algorithms.multifunction
:members:
:undoc-members:
:show-inheritance:

ufl.algorithms.pdiffs module
----------------------------

.. automodule:: ufl.algorithms.pdiffs
:members:
:undoc-members:
:show-inheritance:

ufl.algorithms.predicates module
--------------------------------

.. automodule:: ufl.algorithms.predicates
:members:
:undoc-members:
:show-inheritance:

ufl.algorithms.renumbering module
---------------------------------

.. automodule:: ufl.algorithms.renumbering
:members:
:undoc-members:
:show-inheritance:

ufl.algorithms.replace module
-----------------------------

.. automodule:: ufl.algorithms.replace
:members:
:undoc-members:
:show-inheritance:

ufl.algorithms.signature module
-------------------------------

.. automodule:: ufl.algorithms.signature
:members:
:undoc-members:
:show-inheritance:

ufl.algorithms.transformer module
---------------------------------

.. automodule:: ufl.algorithms.transformer
:members:
:undoc-members:
:show-inheritance:

ufl.algorithms.traversal module
-------------------------------

.. automodule:: ufl.algorithms.traversal
:members:
:undoc-members:
:show-inheritance:


Module contents
---------------

.. automodule:: ufl.algorithms
:members:
:undoc-members:
:show-inheritance:
70 changes: 70 additions & 0 deletions doc/sphinx/source/api-doc/ufl.core.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
ufl.core package
================

Submodules
----------

ufl.core.compute_expr_hash module
---------------------------------

.. automodule:: ufl.core.compute_expr_hash
:members:
:undoc-members:
:show-inheritance:

ufl.core.expr module
--------------------

.. automodule:: ufl.core.expr
:members:
:undoc-members:
:show-inheritance:

ufl.core.multiindex module
--------------------------

.. automodule:: ufl.core.multiindex
:members:
:undoc-members:
:show-inheritance:

ufl.core.operator module
------------------------

.. automodule:: ufl.core.operator
:members:
:undoc-members:
:show-inheritance:

ufl.core.terminal module
------------------------

.. automodule:: ufl.core.terminal
:members:
:undoc-members:
:show-inheritance:

ufl.core.ufl_id module
----------------------

.. automodule:: ufl.core.ufl_id
:members:
:undoc-members:
:show-inheritance:

ufl.core.ufl_type module
------------------------

.. automodule:: ufl.core.ufl_type
:members:
:undoc-members:
:show-inheritance:


Module contents
---------------

.. automodule:: ufl.core
:members:
:undoc-members:
:show-inheritance:
38 changes: 38 additions & 0 deletions doc/sphinx/source/api-doc/ufl.corealg.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
ufl.corealg package
===================

Submodules
----------

ufl.corealg.map_dag module
--------------------------

.. automodule:: ufl.corealg.map_dag
:members:
:undoc-members:
:show-inheritance:

ufl.corealg.multifunction module
--------------------------------

.. automodule:: ufl.corealg.multifunction
:members:
:undoc-members:
:show-inheritance:

ufl.corealg.traversal module
----------------------------

.. automodule:: ufl.corealg.traversal
:members:
:undoc-members:
:show-inheritance:


Module contents
---------------

.. automodule:: ufl.corealg
:members:
:undoc-members:
:show-inheritance:

0 comments on commit b7724a2

Please sign in to comment.