From 0eed45f1d0f006722067312163645dca994fcdef Mon Sep 17 00:00:00 2001 From: caron <j.caron@fz-juelich.de> Date: Wed, 11 Mar 2020 14:40:32 +0100 Subject: [PATCH] Test removing api from docs --- .gitlab-ci.yml | 2 +- docs/api/empyre.fields.rst | 38 --------------------------- docs/api/empyre.io.rst | 10 ------- docs/api/empyre.models.rst | 10 ------- docs/api/empyre.reconstruct.rst | 10 ------- docs/api/empyre.rst | 33 ----------------------- docs/api/empyre.vis.rst | 46 --------------------------------- docs/api/modules.rst | 7 ----- 8 files changed, 1 insertion(+), 155 deletions(-) delete mode 100644 docs/api/empyre.fields.rst delete mode 100644 docs/api/empyre.io.rst delete mode 100644 docs/api/empyre.models.rst delete mode 100644 docs/api/empyre.reconstruct.rst delete mode 100644 docs/api/empyre.rst delete mode 100644 docs/api/empyre.vis.rst delete mode 100644 docs/api/modules.rst diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index b6f2742..0f342a1 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -40,7 +40,7 @@ test_docs: # -o: Directory to place the output files. If it does not exist, it is created. # last parameter: module path - python setup.py clean # TODO: Simplest way to generate version.py without doing anything else? - - sphinx-apidoc -f -e -o docs/api src/empyre + #- sphinx-apidoc -f -e -o docs/api src/empyre # Build the documentation from 'docs' and put into 'build/sphinx': - sphinx-build docs build/sphinx artifacts: diff --git a/docs/api/empyre.fields.rst b/docs/api/empyre.fields.rst deleted file mode 100644 index 4669873..0000000 --- a/docs/api/empyre.fields.rst +++ /dev/null @@ -1,38 +0,0 @@ -empyre.fields package -===================== - -Submodules ----------- - -empyre.fields.field module --------------------------- - -.. automodule:: empyre.fields.field - :members: - :undoc-members: - :show-inheritance: - -empyre.fields.shapes module ---------------------------- - -.. automodule:: empyre.fields.shapes - :members: - :undoc-members: - :show-inheritance: - -empyre.fields.vectors module ----------------------------- - -.. automodule:: empyre.fields.vectors - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: empyre.fields - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/empyre.io.rst b/docs/api/empyre.io.rst deleted file mode 100644 index b90f22c..0000000 --- a/docs/api/empyre.io.rst +++ /dev/null @@ -1,10 +0,0 @@ -empyre.io package -================= - -Module contents ---------------- - -.. automodule:: empyre.io - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/empyre.models.rst b/docs/api/empyre.models.rst deleted file mode 100644 index 084117e..0000000 --- a/docs/api/empyre.models.rst +++ /dev/null @@ -1,10 +0,0 @@ -empyre.models package -===================== - -Module contents ---------------- - -.. automodule:: empyre.models - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/empyre.reconstruct.rst b/docs/api/empyre.reconstruct.rst deleted file mode 100644 index 4824387..0000000 --- a/docs/api/empyre.reconstruct.rst +++ /dev/null @@ -1,10 +0,0 @@ -empyre.reconstruct package -========================== - -Module contents ---------------- - -.. automodule:: empyre.reconstruct - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/empyre.rst b/docs/api/empyre.rst deleted file mode 100644 index a935d59..0000000 --- a/docs/api/empyre.rst +++ /dev/null @@ -1,33 +0,0 @@ -empyre package -============== - -Subpackages ------------ - -.. toctree:: - - empyre.fields - empyre.io - empyre.models - empyre.reconstruct - empyre.vis - -Submodules ----------- - -empyre.version module ---------------------- - -.. automodule:: empyre.version - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: empyre - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/empyre.vis.rst b/docs/api/empyre.vis.rst deleted file mode 100644 index 0a08bbc..0000000 --- a/docs/api/empyre.vis.rst +++ /dev/null @@ -1,46 +0,0 @@ -empyre.vis package -================== - -Submodules ----------- - -empyre.vis.colors module ------------------------- - -.. automodule:: empyre.vis.colors - :members: - :undoc-members: - :show-inheritance: - -empyre.vis.decorators module ----------------------------- - -.. automodule:: empyre.vis.decorators - :members: - :undoc-members: - :show-inheritance: - -empyre.vis.plot2d module ------------------------- - -.. automodule:: empyre.vis.plot2d - :members: - :undoc-members: - :show-inheritance: - -empyre.vis.tools module ------------------------ - -.. automodule:: empyre.vis.tools - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: empyre.vis - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/modules.rst b/docs/api/modules.rst deleted file mode 100644 index aab6102..0000000 --- a/docs/api/modules.rst +++ /dev/null @@ -1,7 +0,0 @@ -empyre -====== - -.. toctree:: - :maxdepth: 4 - - empyre -- GitLab