Commit c7ef04fa authored by Stefan Mauerberger's avatar Stefan Mauerberger
Browse files

Extension of the Sphinx configuration

parent a2a2a0a4
Command line interface
======================
The modules will documented here ...
......@@ -29,7 +29,11 @@ author = 'Schanner, M.A. and Mauerberger, S.'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = []
extensions = ['sphinx.ext.autodoc',
'sphinx.ext.napoleon',
'sphinx.ext.todo',
'sphinx.ext.linkcode',
'sphinxarg.ext']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
......@@ -39,6 +43,16 @@ templates_path = ['_templates']
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True
# Add external links to source code
def linkcode_resolve(domain, info):
'''Returns external links to the source of objects'''
url = 'https://gitext.gfz-potsdam.de/arthus/pymagglobal'
filename = info['module'].replace('.', '/') + '.py'
return url + '/-/tree/master/pymagglobal/' + filename
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
......
Welcome to pymagglobal's documentation!
=======================================
Nothing here yet ...
Leading text ...
.. toctree::
:maxdepth: 2
:caption: Contents:
package_documentation
command_line_interface
Trailing text ...
Indices and tables
==================
......@@ -14,3 +19,4 @@ Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
* :ref:`todo`
Package Documentation
=====================
The modules will documented here ...
.. _todo:
ToDo
====
The following list is automatically created.
.. todolist::
Supports Markdown
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