Commit 3bc81fc7 authored by Paul Gierz's avatar Paul Gierz

try for automatic documentation from source code

parent a25bdb42
......@@ -20,7 +20,8 @@
#
import os
import sys
sys.path.insert(0, os.path.abspath('..'))
sys.path.insert(0, os.path.abspath('../'))
sys.path.insert(1, os.path.abspath('../scope'))
import scope
......@@ -32,7 +33,21 @@ import scope
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.mathjax',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
'sphinx.ext.napoleon',
]
# Order of the autoclass content:
autoclass_content = "both"
autodoc_member_order = "groupwise"
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
......@@ -47,7 +62,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'SCOPE: A Script Based Coupler for Simulations of the Earth System'
project = u'SCOPE'
copyright = u"2019, Paul Gierz"
author = u"Paul Gierz"
......
Modules & Code Documentation
============================
This section shows source code documentation.
.. automodule:: scope
:members:
:undoc-members:
:show-inheritance:
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment