From 8529bc164a2ba1510ef1555396c95a9b17ecead3 Mon Sep 17 00:00:00 2001 From: "Hugo U. R. Strand" Date: Wed, 24 Apr 2019 15:37:15 -0400 Subject: [PATCH] [doc] add contents.rst and documentation.rst The upper doc link was broken, it expected a documentation.rst to exist. Small polish of text. --- doc/about.rst | 4 +++- doc/conf.py.in | 2 +- doc/contents.rst | 39 ++++----------------------------------- doc/documentation.rst | 43 +++++++++++++++++++++++++++++++++++++++++++ doc/index.rst | 2 +- 5 files changed, 52 insertions(+), 38 deletions(-) create mode 100644 doc/documentation.rst diff --git a/doc/about.rst b/doc/about.rst index c0ec4464..69272ffc 100644 --- a/doc/about.rst +++ b/doc/about.rst @@ -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. diff --git a/doc/conf.py.in b/doc/conf.py.in index 4f7cb541..3d6f952d 100644 --- a/doc/conf.py.in +++ b/doc/conf.py.in @@ -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" diff --git a/doc/contents.rst b/doc/contents.rst index 7a599350..2cd84574 100644 --- a/doc/contents.rst +++ b/doc/contents.rst @@ -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 - diff --git a/doc/documentation.rst b/doc/documentation.rst new file mode 100644 index 00000000..63c830fc --- /dev/null +++ b/doc/documentation.rst @@ -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 + diff --git a/doc/index.rst b/doc/index.rst index 4119935f..6281ea07 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -13,4 +13,4 @@ An example application using cpp2py and TRIQS. This documentation is generated based on `rst `_ files and the comments in the sources and headers. -Lets have a look at the :ref:`documentation `. +Lets have a look at the :ref:`documentation `.