try doc

.github/workflows/documentation.yml

@@ -16,12 +16,12 @@ jobs:
           pip install sphinx sphinx_rtd_theme myst_parser
       - name: Sphinx build
         run: |
-          make.bat html
+          sphinx-build docs _build
       - name: Deploy to GitHub Pages
         uses: peaceiris/actions-gh-pages@v3
         if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
         with:
-          publish_branch: master
+          publish_branch: gh-pages
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: docs/_build/
+          publish_dir: _build/
           force_orphan: true

docs/source/conf.py

@@ -14,15 +14,23 @@
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = []
+extensions = ['sphinx.ext.autosummary',
+              'sphinx.ext.napoleon',
+              'sphinx.ext.intersphinx',
+              'sphinx.ext.githubpages',
+              'sphinx.ext.viewcode',
+              # 'myst_nb',
+              'myst_parser',
+              'sphinx_copybutton',
+              'sphinx_design',
+              ]
 
 templates_path = ['_templates']
-exclude_patterns = []
-
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'alabaster'
-html_static_path = ['_static']
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']

docs/source/index.rst

@@ -22,8 +22,8 @@ With pyAML, it WILL be possible to (the software is at conceptualization stage):
 - **easy and friendly configuration**
 - many more features 
 
-
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
+   apidocs/index