Skip to content
This repository has been archived by the owner on Feb 21, 2022. It is now read-only.

Commit

Permalink
Initial work on structuring docs
Browse files Browse the repository at this point in the history
  • Loading branch information
anderslogg committed Aug 2, 2016
1 parent a57e820 commit 97cd385
Show file tree
Hide file tree
Showing 5 changed files with 142 additions and 236 deletions.
100 changes: 0 additions & 100 deletions doc/fenicsmanual.cls

This file was deleted.

122 changes: 73 additions & 49 deletions doc/sphinx/source/api-doc/FIAT.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,42 +20,42 @@ FIAT.argyris module
:undoc-members:
:show-inheritance:

FIAT.asci2vtk2d module
----------------------
FIAT.brezzi_douglas_fortin_marini module
----------------------------------------

.. automodule:: FIAT.asci2vtk2d
.. automodule:: FIAT.brezzi_douglas_fortin_marini
:members:
:undoc-members:
:show-inheritance:

FIAT.asci2vtk3d module
----------------------
FIAT.brezzi_douglas_marini module
---------------------------------

.. automodule:: FIAT.asci2vtk3d
.. automodule:: FIAT.brezzi_douglas_marini
:members:
:undoc-members:
:show-inheritance:

FIAT.brezzi_douglas_fortin_marini module
----------------------------------------
FIAT.bubble module
------------------

.. automodule:: FIAT.brezzi_douglas_fortin_marini
.. automodule:: FIAT.bubble
:members:
:undoc-members:
:show-inheritance:

FIAT.brezzi_douglas_marini module
---------------------------------
FIAT.crouzeix_raviart module
----------------------------

.. automodule:: FIAT.brezzi_douglas_marini
.. automodule:: FIAT.crouzeix_raviart
:members:
:undoc-members:
:show-inheritance:

FIAT.crouzeix_raviart module
----------------------------
FIAT.discontinuous module
-------------------------

.. automodule:: FIAT.crouzeix_raviart
.. automodule:: FIAT.discontinuous
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -76,6 +76,14 @@ FIAT.discontinuous_raviart_thomas module
:undoc-members:
:show-inheritance:

FIAT.discontinuous_taylor module
--------------------------------

.. automodule:: FIAT.discontinuous_taylor
:members:
:undoc-members:
:show-inheritance:

FIAT.dual_set module
--------------------

Expand All @@ -84,18 +92,18 @@ FIAT.dual_set module
:undoc-members:
:show-inheritance:

FIAT.expansions module
----------------------
FIAT.enriched module
--------------------

.. automodule:: FIAT.expansions
.. automodule:: FIAT.enriched
:members:
:undoc-members:
:show-inheritance:

FIAT.factorial module
---------------------
FIAT.expansions module
----------------------

.. automodule:: FIAT.factorial
.. automodule:: FIAT.expansions
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -116,6 +124,30 @@ FIAT.functional module
:undoc-members:
:show-inheritance:

FIAT.gauss_legendre module
--------------------------

.. automodule:: FIAT.gauss_legendre
:members:
:undoc-members:
:show-inheritance:

FIAT.gauss_lobatto_legendre module
----------------------------------

.. automodule:: FIAT.gauss_lobatto_legendre
:members:
:undoc-members:
:show-inheritance:

FIAT.hdivcurl module
--------------------

.. automodule:: FIAT.hdivcurl
:members:
:undoc-members:
:show-inheritance:

FIAT.hermite module
-------------------

Expand All @@ -140,14 +172,6 @@ FIAT.lagrange module
:undoc-members:
:show-inheritance:

FIAT.makelags module
--------------------

.. automodule:: FIAT.makelags
:members:
:undoc-members:
:show-inheritance:

FIAT.morley module
------------------

Expand All @@ -172,10 +196,10 @@ FIAT.nedelec_second_kind module
:undoc-members:
:show-inheritance:

FIAT.newdubiner module
----------------------
FIAT.orthopoly module
---------------------

.. automodule:: FIAT.newdubiner
.. automodule:: FIAT.orthopoly
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -196,6 +220,14 @@ FIAT.quadrature module
:undoc-members:
:show-inheritance:

FIAT.quadrature_schemes module
------------------------------

.. automodule:: FIAT.quadrature_schemes
:members:
:undoc-members:
:show-inheritance:

FIAT.raviart_thomas module
--------------------------

Expand All @@ -220,18 +252,18 @@ FIAT.regge module
:undoc-members:
:show-inheritance:

FIAT.tabarg module
------------------
FIAT.restricted module
----------------------

.. automodule:: FIAT.tabarg
.. automodule:: FIAT.restricted
:members:
:undoc-members:
:show-inheritance:

FIAT.tablag module
------------------
FIAT.tensor_product module
--------------------------

.. automodule:: FIAT.tablag
.. automodule:: FIAT.tensor_product
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -244,18 +276,10 @@ FIAT.trace module
:undoc-members:
:show-inheritance:

FIAT.transform_hermite module
-----------------------------

.. automodule:: FIAT.transform_hermite
:members:
:undoc-members:
:show-inheritance:

FIAT.transform_morley module
----------------------------
FIAT.trace_hdiv module
----------------------

.. automodule:: FIAT.transform_morley
.. automodule:: FIAT.trace_hdiv
:members:
:undoc-members:
:show-inheritance:
Expand Down
34 changes: 20 additions & 14 deletions doc/sphinx/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,27 +1,33 @@
.. title:: FInite element Automatic Tabulator
.. title:: FIAT


FInite element Automatic Tabulator (FIAT)
=========================================
========================================
FIAT: FInite element Automatic Tabulator
========================================

The FInite element Automatic Tabulator FIAT supports generation of
arbitrary order instances of the Lagrange elements on lines,
triangles, and tetrahedra. It is also capable of generating arbitrary
order instances of Jacobi-type quadrature rules on the same element
shapes. Further, H(div) and H(curl) conforming finite element spaces
such as the families of Raviart-Thomas, Brezzi-Douglas-Marini and
Nedelec are supported on triangles and tetrahedra. Upcoming versions
will also support Hermite and nonconforming elements. For more
information, visit http://www.fenicsproject.org.
FIAT is a Python package for automatic generation of finite element
basis functions. It is capable of generating finite element basis
functions for a wide range of finite element families on simplices
(lines, triangles and tetrahedra), including the Lagrange elements,
and the elements of Raviart-Thomas, Brezzi-Douglas-Marini and Nedelec.
It is also capable of generating tensor-product elements and a number
more exotic elements, such as the Argyris, Hermite and Morley
elements.

FIAT is part of the FEniCS Project.

For more information, visit http://www.fenicsproject.org.


Documentation
-------------
=============

.. toctree::
:titlesonly:

api-doc/FIAT
installation
manual
API reference <api-doc/FIAT>
releases

* :ref:`genindex`
Expand Down

0 comments on commit 97cd385

Please sign in to comment.