doc/: Some first tests with automatically generated documentation using...

doc/: Some first tests with automatically generated documentation using doc-strings from the source code. It is working in principle, however, the doc-strings of the single pyicon functions / classes are not really appropriate to give a satisfying result.

doc/api.rst

+API for pyicon
+==============
+
+::
+
+  Warning! This automatically generated documentation 
+  is still under development!
+
+Some semi-automatically generate documentation about the pyicon API.
+
+.. automodule:: pyicon
+
+pyicon.pyicon_IconData
+----------------------
+
+.. automodule:: pyicon.pyicon_IconData
+  :members:
+
+pyicon.pyicon_plotting
+----------------------
+
+.. automodule:: pyicon.pyicon_plotting
+  :members:

doc/conf.py

@@ -15,10 +15,11 @@
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-# import os
-# import sys
+
+import os
+import sys
 # sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('../..'))  # Source code dir relative to this file
 
 
 # -- General configuration ------------------------------------------------
@@ -34,10 +35,11 @@ extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.todo',
     'sphinx.ext.imgmath',
-    'nbsphinx',
-    "sphinx_copybutton",
-    "IPython.sphinxext.ipython_directive",
-    "IPython.sphinxext.ipython_console_highlighting",
+#    'sphinx.ext.autosummary',
+#    'nbsphinx',
+#    "sphinx_copybutton",
+#    "IPython.sphinxext.ipython_directive",
+#    "IPython.sphinxext.ipython_console_highlighting",
 ]
 
 # Add any paths that contain templates here, relative to this directory.

doc/index.rst

@@ -24,6 +24,7 @@ Pyicon is hosted here: `<https://gitlab.dkrz.de/m300602/pyicon/>`_
    documentation
    quickplots
    view
+   api
 
   
 Indices and tables