qp2/docs/source/index.rst

59 lines
1.1 KiB
ReStructuredText

.. Quantum Package documentation master file, created by
sphinx-quickstart on Thu Oct 18 11:53:23 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. include:: intro/intro.rst
.. toctree::
:maxdepth: 1
:caption: Introduction
:hidden:
intro/install
intro/selected_ci
.. toctree::
:maxdepth: 1
:caption: User's guide
:glob:
:hidden:
users_guide/quickstart
users_guide/interfaces
users_guide/excited_states
users_guide/natural_orbitals
users_guide/printing
users_guide/plugins
users_guide/index
.. toctree::
:maxdepth: 1
:caption: Programmer's guide
:hidden:
programmers_guide/programming
programmers_guide/ezfio
programmers_guide/plugins
programmers_guide/plugins_tuto_intro
programmers_guide/plugins_tuto_I
programmers_guide/new_ks
programmers_guide/index
.. toctree::
:maxdepth: 1
:caption: Appendix
:hidden:
appendix/benchmarks
appendix/license
appendix/contributors
appendix/references