Expand WCompBase docstrings

rafmudaf · Mar 11, 2024 · fa44837 · fa44837
1 parent 172907f
commit fa44837
Show file tree

Hide file tree

Showing 3 changed files with 244 additions and 45 deletions.
diff --git a/.github/workflows/deploy-pages.yaml b/.github/workflows/deploy-pages.yaml
@@ -4,8 +4,8 @@ on:
   push:
     # branches:
     # - develop
-    paths:
-    - docs/**
+    # paths:
+    # - docs/**
 
 # This job installs dependencies, builds the book, and pushes it to `gh-pages`
 jobs:

diff --git a/docs/_config.yml b/docs/_config.yml
@@ -33,8 +33,8 @@ sphinx:
   - 'sphinx.ext.viewcode'
   # - 'sphinx_autodoc_typehints'
   # - 'sphinxcontrib.autoyaml'
-  # - 'sphinx.ext.napoleon'               # Formats google and numpy docstring styles
-  - 'sphinxcontrib.mermaid'
+  - 'sphinx.ext.napoleon'           # Formats docstring for Google and NumPy style, https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html
+  - 'sphinxcontrib.mermaid'         # https://sphinxcontrib-mermaid-demo.readthedocs.io/en/latest/
 
   config:
     # html_theme: sphinx_book_theme
@@ -56,6 +56,8 @@ sphinx:
       undoc-members: true
       private-members: false
       # special-members: true
+      special-members': __init__
+
       # inherited-members
       # show-inheritance
       # ignore-module-all
@@ -65,4 +67,5 @@ sphinx:
       # no-value
     autodoc_typehints: both
     # mermaid_output_format: png
-    mermaid_version: 10.9.0
+    mermaid_version: 10.9.0
+    # napoleon_use_admonition_for_examples: true