diff --git a/.github/workflows/docs-job/action.yml b/.github/workflows/docs-job/action.yml index 9b59fc5d..41ad71db 100644 --- 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 index 003c02ec..d817c762 100644 --- a/.gitignore +++ b/.gitignore @@ -7,4 +7,4 @@ dist/ *.egg build/ public/ -docs/source/yadg*.rst \ No newline at end of file +docs/source/apidoc/ \ No newline at end of file diff --git a/docs/apidoc/module.rst_t b/docs/apidoc_t/module.rst_t similarity index 100% rename from docs/apidoc/module.rst_t rename to docs/apidoc_t/module.rst_t diff --git a/docs/apidoc/package.rst_t b/docs/apidoc_t/package.rst_t similarity index 100% rename from docs/apidoc/package.rst_t rename to docs/apidoc_t/package.rst_t diff --git a/docs/source/index.rst b/docs/source/index.rst index 4799f3aa..6c345171 100644 --- 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 index 4327d82e..4c1da619 100644 --- 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 \ No newline at end of file