[doc] add contents.rst and documentation.rst

The upper doc link was broken, it expected a documentation.rst to exist.
Small polish of text.
This commit is contained in:
Hugo U. R. Strand 2019-04-24 15:37:15 -04:00 committed by Nils Wentzell
parent 171dbcdecf
commit 8529bc164a
5 changed files with 52 additions and 38 deletions

View File

@ -3,4 +3,6 @@
About app4triqs
===============
An example application using cpp2py and triqs.
An example application using ``cpp2py`` and TRIQS.
Written and maintained by N. Wentzell with contributions from H. U.R. Strand.

View File

@ -20,7 +20,7 @@ extensions = ['sphinx.ext.autodoc',
source_suffix = '.rst'
project = u'APP4TRIQS - An example triqs application'
copyright = u'2018 - The TRIQS Developers'
copyright = u'2018 Simons Foundation - authors: N. Wentzell and H. U.R. Strand'
version = '@APP4TRIQS_VERSION@'
mathjax_path = "@TRIQS_MATHJAX_PATH@/MathJax.js?config=default"

View File

@ -1,43 +1,12 @@
.. _contents:
Documentation
=============
Contents
--------
.. math::
(a + b)^2 &= (a + b)(a + b) \\
&= a^2 + 2ab + b^2
Table of contents
=================
.. toctree::
:maxdepth: 5
:maxdepth: 2
index
install
documentation
issues
changelog
about
C++ reference manual
--------------------
.. toctree::
:maxdepth: 5
cpp2rst_generated/app4triqs/toto
cpp2rst_generated/app4triqs/chain
Python reference manual
-----------------------
.. automodule:: app4triqs
:members:
.. autoclass:: app4triqs.toto_module.toto
:members:
.. autofunction:: app4triqs.toto_module.chain

43
doc/documentation.rst Normal file
View File

@ -0,0 +1,43 @@
.. _documentation:
Documentation
=============
Contents
--------
.. math::
(a + b)^2 &= (a + b)(a + b) \\
&= a^2 + 2ab + b^2
.. toctree::
:maxdepth: 5
index
install
issues
changelog
about
C++ reference manual
--------------------
.. toctree::
:maxdepth: 5
cpp2rst_generated/app4triqs/toto
cpp2rst_generated/app4triqs/chain
Python reference manual
-----------------------
.. automodule:: app4triqs
:members:
.. autoclass:: app4triqs.toto_module.Toto
:members:
.. autofunction:: app4triqs.toto_module.chain

View File

@ -13,4 +13,4 @@ An example application using cpp2py and TRIQS.
This documentation is generated based on `rst <https://de.wikipedia.org/wiki/ReStructuredText>`_ files
and the comments in the sources and headers.
Lets have a look at the :ref:`documentation <contents>`.
Lets have a look at the :ref:`documentation <documentation>`.