LCPQ/dft_tools
3
0
Fork 0
mirror of https://github.com/triqs/dft_tools synced 2024-11-01 11:43:47 +01:00
Code Issues Releases Wiki Activity
56820a9493
dft_tools/doc/documentation.rst

80 lines
1.3 KiB
ReStructuredText
Raw Normal View History

Work on documentation Included logos, added docuentation thumbnail and organized contents in a way that navigating in the python and c++ reference will be easier. Applications appear in a special sidebar.
2013-08-26 18:00:59 +02:00
.. _documentation:
Documentation
=============
A quick tour
------------
Restructuring documentation. A first general restructuration of the doc according to the pattern [tour|tutorial|reference]. In the reference part, objects are documented per topic. In each topic, [definition|c++|python|hdf5] (not yet implemented)
2014-10-17 18:15:19 +02:00
A little tour of some aspects of TRIQS and its applications, at the Python level.
.. toctree::
:maxdepth: 1
tour/getting_started/get_started
tour/green
tour/tight_binding
tour/ctqmc
tour/dmft
tour/ipt
Tutorials
----------
Learn how to use TRIQS step by step, both in Python and c++ !
Work on documentation Included logos, added docuentation thumbnail and organized contents in a way that navigating in the python and c++ reference will be easier. Applications appear in a special sidebar.
2013-08-26 18:00:59 +02:00
.. toctree::
:maxdepth: 1
Restructuring documentation. A first general restructuration of the doc according to the pattern [tour|tutorial|reference]. In the reference part, objects are documented per topic. In each topic, [definition|c++|python|hdf5] (not yet implemented)
2014-10-17 18:15:19 +02:00
tutorials/gfs_tutorial
tutorials/array_tutorial
tutorials/det_manip_tutorial
Work on documentation Included logos, added docuentation thumbnail and organized contents in a way that navigating in the python and c++ reference will be easier. Applications appear in a special sidebar.
2013-08-26 18:00:59 +02:00
Work on doc - remove empty parts, start to clean the tour. - added export of _template and _static to reuse in appli doc. - clean tutorial part. rm cookbook.
2013-08-31 00:04:09 +02:00
Reference manual
-----------------
Work on documentation Included logos, added docuentation thumbnail and organized contents in a way that navigating in the python and c++ reference will be easier. Applications appear in a special sidebar.
2013-08-26 18:00:59 +02:00
Restructuring documentation. A first general restructuration of the doc according to the pattern [tour|tutorial|reference]. In the reference part, objects are documented per topic. In each topic, [definition|c++|python|hdf5] (not yet implemented)
2014-10-17 18:15:19 +02:00
.. toctree::
:maxdepth: 1
reference/using_the_lib/contents
Work on documentation Included logos, added docuentation thumbnail and organized contents in a way that navigating in the python and c++ reference will be easier. Applications appear in a special sidebar.
2013-08-26 18:00:59 +02:00
Restructuring documentation. A first general restructuration of the doc according to the pattern [tour|tutorial|reference]. In the reference part, objects are documented per topic. In each topic, [definition|c++|python|hdf5] (not yet implemented)
2014-10-17 18:15:19 +02:00
Code reference
~~~~~~~~~~~~~~~~
Work on documentation Included logos, added docuentation thumbnail and organized contents in a way that navigating in the python and c++ reference will be easier. Applications appear in a special sidebar.
2013-08-26 18:00:59 +02:00
.. toctree::
Restructuring documentation. A first general restructuration of the doc according to the pattern [tour|tutorial|reference]. In the reference part, objects are documented per topic. In each topic, [definition|c++|python|hdf5] (not yet implemented)
2014-10-17 18:15:19 +02:00
:maxdepth: 1
reference/gfs/contents
reference/lattice_tools/contents
reference/plotting_protocols/contents
reference/montecarlo/contents
reference/operators/contents
reference/random_generator/contents
reference/arrays/contents
reference/clef/contents
reference/hdf5/contents
reference/determinant_manipulation/contents
reference/statistical_analysis/contents
Developer tools
~~~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 1
Work on documentation Included logos, added docuentation thumbnail and organized contents in a way that navigating in the python and c++ reference will be easier. Applications appear in a special sidebar.
2013-08-26 18:00:59 +02:00
Restructuring documentation. A first general restructuration of the doc according to the pattern [tour|tutorial|reference]. In the reference part, objects are documented per topic. In each topic, [definition|c++|python|hdf5] (not yet implemented)
2014-10-17 18:15:19 +02:00
reference/conventions
reference/using_the_lib/profiling
reference/wrap_generator/contents
reference/utilities/contents
Work on documentation modified: doc/applications.rst modified: doc/index.rst modified: doc/install.rst modified: doc/installation/clang.rst modified: doc/installation/install_options.rst modified: doc/installation/requirements.rst modified: doc/installation/ubuntu.rst new file: doc/changelog.rst new file: doc/versions.rst
2013-08-30 16:15:47 +02:00
Version compatibility
---------------------
.. toctree::
:maxdepth: 1
versions
Reference in New Issue Copy Permalink