Update: Documentation

.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

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
+.. automodule:: kheops.plugin.backend.file
-   :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
    :members:
    :undoc-members:
    :show-inheritance:

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

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:

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:

docs/api/kheops.rst

@@ -33,18 +33,10 @@ kheops.cli module
    :undoc-members:
    :show-inheritance:
 
-kheops.managers module
+kheops.controllers module
-----------------------
+-------------------------
 
-.. automodule:: kheops.managers
+.. automodule:: kheops.controllers
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-kheops.query module
--------------------
-
-.. automodule:: kheops.query
    :members:
    :undoc-members:
    :show-inheritance:

docs/api/modules.rst

@@ -2,6 +2,6 @@ kheops
 ======
 
 .. toctree::
-   :maxdepth: 8
+   :maxdepth: 4
 
    kheops

docs/build_doc.sh

@@ -2,8 +2,8 @@
 
 make clean
 
-#sphinx-apidoc -f -M -o ./api ../kheops/
+sphinx-apidoc -f -M -o ./api ../kheops/
-sphinx-apidoc -M -o ./api ../kheops/
+#sphinx-apidoc -M -o ./api ../kheops/
 
 mkdir -p learn
 jupyter nbconvert --to markdown --output=../learn/learn101.md jupyter/learn101.ipynb

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,

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"]