updating documentation

jhillairet · Sep 1, 2021 · 7d1f8bd · 7d1f8bd
1 parent 2c8bda3
commit 7d1f8bd
Show file tree

Hide file tree

Showing 12 changed files with 2,768 additions and 84 deletions.
diff --git a/doc/Makefile b/doc/Makefile
@@ -3,7 +3,7 @@
 
 # You can set these variables from the command line, and also
 # from the environment for the first two.
-#SPHINXOPTS    ?=
+SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = source
 BUILDDIR      = build

diff --git a/doc/WEST_Antenna_Circuit_Model.pptx b/doc/WEST_Antenna_Circuit_Model.pptx
diff --git a/doc/West_Antenna_water_load.png b/doc/West_Antenna_water_load.png
diff --git a/doc/West_front_face_ideal.png b/doc/West_front_face_ideal.png
diff --git a/doc/West_front_face_simplified_dielectric.png b/doc/West_front_face_simplified_dielectric.png
diff --git a/doc/automatic_matching_transmission_line_definition.png b/doc/automatic_matching_transmission_line_definition.png
diff --git a/doc/coupling_to_plasma_from_TOPICA.ipynb b/doc/coupling_to_plasma_from_TOPICA.ipynb
diff --git a/doc/digital_twin.ipynb b/doc/digital_twin.ipynb
diff --git a/doc/phase_scan.ipynb b/doc/phase_scan.ipynb
diff --git a/doc/source/antenna.rst b/doc/source/antenna.rst
@@ -1,4 +1,5 @@
-WestIcrhAntenna
-===============
+WEST ICRH Antenna RF Model
+==========================
+
 .. automodule:: west_ic_antenna.antenna
     :members:
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -13,7 +13,6 @@
 import os
 import sys
 sys.path.insert(0, os.path.abspath('../..'))
-sys.path.insert(0, os.path.abspath('../../../scikit-rf'))
 sys.setrecursionlimit(1500)
 import sphinx_rtd_theme
 
@@ -35,11 +34,10 @@
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon', 
     'sphinx.ext.autosummary',
-    'sphinx.ext.napoleon',
     'sphinx.ext.mathjax',
     'sphinx.ext.viewcode',
-
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -66,6 +64,10 @@
 # Autodoc settings
 autodoc_typehints = "description"
 
+# Autosummary settings
+# generate stub pages for each. It is enabled by default.
+autosummary_generate = True
+
 # Napoleon settings
 napoleon_google_docstring = False
 napoleon_numpy_docstring = True

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -6,14 +6,10 @@
 WEST ICRH Antenna RF Model's documentation
 ==========================================
 
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
-
-Documentation
-=============
+API Documentation
+=================
 
-.. toctree::
+.. toctree:: generated/
     :maxdepth: 2
 
     antenna