Skip to content

Commit

Permalink
docs: index.rst is expected at the project root
Browse files Browse the repository at this point in the history
  • Loading branch information
Puerling committed Oct 18, 2024
1 parent 14ea820 commit a2fc0c3
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 63 deletions.
2 changes: 1 addition & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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") ]
Expand Down
62 changes: 0 additions & 62 deletions docs/index.rst

This file was deleted.

62 changes: 62 additions & 0 deletions index.rst
Original file line number Diff line number Diff line change
@@ -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 <README>
Qt desktop user interface <docs/UI-Qt>
ImGui desktop user interface <docs/UI-ImGui>
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 <docs/Build_Unix_OSX>
Build on Windows <docs/Build_Windows>
Using Docker <docs/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 <https://github.com/spirit-code/spirit/blob/master/LICENSE.txt>
Contributing <docs/CONTRIBUTING>
Contributors <docs/CONTRIBUTORS>
Referencing this Code <docs/REFERENCE>
Included dependencies <docs/Dependencies>


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

0 comments on commit a2fc0c3

Please sign in to comment.