diff --git a/conf.py b/conf.py index d23dea4ca..e52cf6d42 100644 --- a/conf.py +++ b/conf.py @@ -69,7 +69,7 @@ # The master toctree document. -master_doc = 'docs/index' +master_doc = 'index' # man_pages = [ master_doc, ("docs/BUILD", "build", "building", "authors", "sectionbuild") ] diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 4872a614e..000000000 --- a/docs/index.rst +++ /dev/null @@ -1,62 +0,0 @@ -.. Spirit documentation master file, created by - sphinx-quickstart on Thu Jul 13 16:49:07 2017. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - :navtree_shift: True - :navtree_root_links: True - -Spirit - Spin Simulation Framework -================================== - -.. image:: https://imgur.com/iWc1kuE.png - -.. toctree:: - :maxdepth: 1 - - Introduction <../README> - Qt desktop user interface - ImGui desktop user interface - Input file specification <../core/docs/Input> - Definitions <../core/docs/Definitions> - Additional features <../core/docs/Features> - Hamiltonian <../core/docs/Hamiltonian> - -.. toctree:: - :maxdepth: 2 - :caption: Installation - - Build on Unix/OSX - Build on Windows - Using Docker - -.. toctree:: - :maxdepth: 3 - :caption: C API - - Usage <../core/docs/C_API> - Full Reference <../core/docs/c-api/API_Reference> - -.. toctree:: - :maxdepth: 3 - :caption: Python API - - Usage <../core/docs/Python_API> - Full Reference <../core/docs/python-api/API_Reference> - -.. toctree:: - :maxdepth: 1 - :caption: Further Information - - License - Contributing - Contributors - Referencing this Code - Included dependencies - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/index.rst b/index.rst new file mode 100644 index 000000000..0005a9d9e --- /dev/null +++ b/index.rst @@ -0,0 +1,62 @@ +.. Spirit documentation master file, created by + sphinx-quickstart on Thu Jul 13 16:49:07 2017. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + :navtree_shift: True + :navtree_root_links: True + +Spirit - Spin Simulation Framework +================================== + +.. image:: https://imgur.com/iWc1kuE.png + +.. toctree:: + :maxdepth: 1 + + Introduction + Qt desktop user interface + ImGui desktop user interface + Input file specification + Definitions + Additional features + Hamiltonian + +.. toctree:: + :maxdepth: 2 + :caption: Installation + + Build on Unix/OSX + Build on Windows + Using Docker + +.. toctree:: + :maxdepth: 3 + :caption: C API + + Usage + Full Reference + +.. toctree:: + :maxdepth: 3 + :caption: Python API + + Usage + Full Reference + +.. toctree:: + :maxdepth: 1 + :caption: Further Information + + License + Contributing + Contributors + Referencing this Code + Included dependencies + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search`