From 0f31a1492075b063ec1daee8c1734661dfa17f39 Mon Sep 17 00:00:00 2001 From: mrjk Date: Wed, 23 Mar 2022 12:11:56 -0400 Subject: [PATCH] Update: Documentation --- .github/workflows/sphinx.yml | 4 ++-- docs/api/kheops.plugin.backend.rst | 20 ++------------------ docs/api/kheops.plugin.rst | 2 +- docs/api/kheops.plugin.scope.rst | 26 ++++++++++++++++++++++++++ docs/api/kheops.plugin.strategy.rst | 14 +++++++++++--- docs/api/kheops.rst | 14 +++----------- docs/api/modules.rst | 2 +- docs/build_doc.sh | 4 ++-- docs/conf.py | 2 +- pyproject.toml | 1 + 10 files changed, 50 insertions(+), 39 deletions(-) create mode 100644 docs/api/kheops.plugin.scope.rst diff --git a/.github/workflows/sphinx.yml b/.github/workflows/sphinx.yml index 95d61e9..1c03785 100644 --- a/.github/workflows/sphinx.yml +++ b/.github/workflows/sphinx.yml @@ -4,7 +4,7 @@ name: sphinx on: [push, pull_request] env: - DEFAULT_BRANCH: "master" + DEFAULT_BRANCH: "main" #SPHINXOPTS: "-W --keep-going -T" # ^-- If these SPHINXOPTS are enabled, then be strict about the builds and fail on any warnings @@ -91,7 +91,7 @@ jobs: working-directory: ./docs #if: ${{ github.event_name == 'push' }} run: | - touch _build/.nojekyll + touch _build/html/.nojekyll # Deploy # https://github.com/peaceiris/actions-gh-pages diff --git a/docs/api/kheops.plugin.backend.rst b/docs/api/kheops.plugin.backend.rst index 4d48fe6..77d53bb 100644 --- a/docs/api/kheops.plugin.backend.rst +++ b/docs/api/kheops.plugin.backend.rst @@ -9,26 +9,10 @@ kheops.plugin.backend package Submodules ---------- -kheops.plugin.backend.hier module +kheops.plugin.backend.file module --------------------------------- -.. automodule:: kheops.plugin.backend.hier - :members: - :undoc-members: - :show-inheritance: - -kheops.plugin.backend.init module ---------------------------------- - -.. automodule:: kheops.plugin.backend.init - :members: - :undoc-members: - :show-inheritance: - -kheops.plugin.backend.loop module ---------------------------------- - -.. automodule:: kheops.plugin.backend.loop +.. automodule:: kheops.plugin.backend.file :members: :undoc-members: :show-inheritance: diff --git a/docs/api/kheops.plugin.rst b/docs/api/kheops.plugin.rst index c8edaa1..444a3bc 100644 --- a/docs/api/kheops.plugin.rst +++ b/docs/api/kheops.plugin.rst @@ -13,7 +13,7 @@ Subpackages :maxdepth: 4 kheops.plugin.backend - kheops.plugin.engine + kheops.plugin.scope kheops.plugin.strategy Submodules diff --git a/docs/api/kheops.plugin.scope.rst b/docs/api/kheops.plugin.scope.rst new file mode 100644 index 0000000..5d2c06d --- /dev/null +++ b/docs/api/kheops.plugin.scope.rst @@ -0,0 +1,26 @@ +kheops.plugin.scope package +=========================== + +.. automodule:: kheops.plugin.scope + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +kheops.plugin.scope.hier module +------------------------------- + +.. automodule:: kheops.plugin.scope.hier + :members: + :undoc-members: + :show-inheritance: + +kheops.plugin.scope.loop module +------------------------------- + +.. automodule:: kheops.plugin.scope.loop + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/kheops.plugin.strategy.rst b/docs/api/kheops.plugin.strategy.rst index 8bc7b0d..3638bfe 100644 --- a/docs/api/kheops.plugin.strategy.rst +++ b/docs/api/kheops.plugin.strategy.rst @@ -17,10 +17,18 @@ kheops.plugin.strategy.last module :undoc-members: :show-inheritance: -kheops.plugin.strategy.schema module ------------------------------------- +kheops.plugin.strategy.merge\_deep module +----------------------------------------- -.. automodule:: kheops.plugin.strategy.schema +.. automodule:: kheops.plugin.strategy.merge_deep + :members: + :undoc-members: + :show-inheritance: + +kheops.plugin.strategy.merge\_schema module +------------------------------------------- + +.. automodule:: kheops.plugin.strategy.merge_schema :members: :undoc-members: :show-inheritance: diff --git a/docs/api/kheops.rst b/docs/api/kheops.rst index b8b3e0f..4af2e99 100644 --- a/docs/api/kheops.rst +++ b/docs/api/kheops.rst @@ -33,18 +33,10 @@ kheops.cli module :undoc-members: :show-inheritance: -kheops.managers module ----------------------- +kheops.controllers module +------------------------- -.. automodule:: kheops.managers - :members: - :undoc-members: - :show-inheritance: - -kheops.query module -------------------- - -.. automodule:: kheops.query +.. automodule:: kheops.controllers :members: :undoc-members: :show-inheritance: diff --git a/docs/api/modules.rst b/docs/api/modules.rst index bf8b209..3a299b5 100644 --- a/docs/api/modules.rst +++ b/docs/api/modules.rst @@ -2,6 +2,6 @@ kheops ====== .. toctree:: - :maxdepth: 8 + :maxdepth: 4 kheops diff --git a/docs/build_doc.sh b/docs/build_doc.sh index da9ba54..06c1586 100755 --- a/docs/build_doc.sh +++ b/docs/build_doc.sh @@ -2,8 +2,8 @@ make clean -#sphinx-apidoc -f -M -o ./api ../kheops/ -sphinx-apidoc -M -o ./api ../kheops/ +sphinx-apidoc -f -M -o ./api ../kheops/ +#sphinx-apidoc -M -o ./api ../kheops/ mkdir -p learn jupyter nbconvert --to markdown --output=../learn/learn101.md jupyter/learn101.ipynb diff --git a/docs/conf.py b/docs/conf.py index 383d28a..a83441e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -53,7 +53,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'alabaster' +html_theme = 'sphinx_rtd_theme' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/pyproject.toml b/pyproject.toml index 6a7050f..da60684 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -33,6 +33,7 @@ pytest = "^6.2.5" pytest-icdiff = "^0.5" pytest-instafail = "^0.4.2" pytest-cov = "^3.0.0" +sphinx-rtd-theme = "^1.0.0" [build-system] requires = ["poetry-core>=1.0.0"]