Rejig index page in docs. (#81)

dgbowl · Aug 18, 2022 · a509411 · a509411
1 parent d1cbd6c
commit a509411
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 16 deletions.
diff --git a/.github/workflows/docs-job/action.yml b/.github/workflows/docs-job/action.yml
@@ -3,7 +3,7 @@ description: "Build the documentation."
 runs:
   using: "composite"
   steps:
-    - run: sphinx-apidoc -o docs/source src/yadg -T -M -E -f --templatedir=docs/apidoc
+    - run: sphinx-apidoc -o docs/source/apidoc src/yadg -T -M -E -f --templatedir=docs/apidoc_t
       shell: bash
     - run: sphinx-build -W -b html docs/source public/master
       shell: bash
diff --git a/.gitignore b/.gitignore
@@ -7,4 +7,4 @@ dist/
 *.egg
 build/
 public/
-docs/source/yadg*.rst
+docs/source/apidoc/
diff --git a/docs/apidoc/module.rst_t → docs/apidoc_t/module.rst_t b/docs/apidoc/module.rst_t → docs/apidoc_t/module.rst_t
diff --git a/docs/apidoc/package.rst_t → docs/apidoc_t/package.rst_t b/docs/apidoc/package.rst_t → docs/apidoc_t/package.rst_t
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -25,13 +25,12 @@ You can read more about yadg in our paper: [Kraus2022b]_.
 .. toctree::
    :maxdepth: 3
    :caption: yadg user manual
-   :hidden:
 
    usage
    features
-   parsers
    citing
 
+.. include:: parsers.rst
 
 .. toctree::
    :maxdepth: 1
@@ -41,4 +40,4 @@ You can read more about yadg in our paper: [Kraus2022b]_.
    devdocs
    version
    objects
-   yadg
+   apidoc/yadg
diff --git a/docs/source/parsers.rst b/docs/source/parsers.rst
@@ -7,16 +7,17 @@ following links:
 
 .. toctree::
    :maxdepth: 1
+   :caption: yadg parsers
 
-   yadg.parsers.dummy
-   yadg.parsers.basiccsv
-   yadg.parsers.meascsv
-   yadg.parsers.flowdata
-   yadg.parsers.electrochem
-   yadg.parsers.chromtrace
-   yadg.parsers.chromdata
-   yadg.parsers.qftrace
-   yadg.parsers.xpstrace
-   yadg.parsers.xrdtrace
-   yadg.parsers.masstrace
+   apidoc/yadg.parsers.dummy
+   apidoc/yadg.parsers.basiccsv
+   apidoc/yadg.parsers.meascsv
+   apidoc/yadg.parsers.flowdata
+   apidoc/yadg.parsers.electrochem
+   apidoc/yadg.parsers.chromtrace
+   apidoc/yadg.parsers.chromdata
+   apidoc/yadg.parsers.qftrace
+   apidoc/yadg.parsers.xpstrace
+   apidoc/yadg.parsers.xrdtrace
+   apidoc/yadg.parsers.masstrace
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,4 +7,4 @@ dist/ @@
     *.egg
     build/
     public/
-    docs/source/yadg*.rst
+    docs/source/apidoc/