Commit 5749626a authored by Paul Gierz's avatar Paul Gierz

docs work automatically

parent 3bc81fc7
......@@ -20,8 +20,9 @@
#
import os
import sys
sys.path.insert(0, os.path.abspath('../'))
sys.path.insert(1, os.path.abspath('../scope'))
sys.path.insert(0, os.path.abspath("../"))
sys.path.insert(1, os.path.abspath("../scope"))
import scope
......@@ -34,35 +35,35 @@ 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.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.mathjax',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
'sphinx.ext.napoleon',
]
"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"
autodoc_default_flags = ["private-members"]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
templates_path = ["_templates"]
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
source_suffix = ".rst"
# The master toctree document.
master_doc = 'index'
master_doc = "index"
# General information about the project.
project = u'SCOPE'
project = u"SCOPE"
copyright = u"2019, Paul Gierz"
author = u"Paul Gierz"
......@@ -85,10 +86,10 @@ language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = "sphinx"
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
......@@ -99,7 +100,7 @@ todo_include_todos = False
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
html_theme = "alabaster"
# Theme options are theme-specific and customize the look and feel of a
# theme further. For a list of options available for each theme, see the
......@@ -110,13 +111,13 @@ html_theme = 'alabaster'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = ["_static"]
# -- Options for HTMLHelp output ---------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'scopedoc'
htmlhelp_basename = "scopedoc"
# -- Options for LaTeX output ------------------------------------------
......@@ -125,15 +126,12 @@ latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
......@@ -143,9 +141,13 @@ latex_elements = {
# (source start file, target name, title, author, documentclass
# [howto, manual, or own class]).
latex_documents = [
(master_doc, 'scope.tex',
u'SCOPE: A Script Based Coupler for Simulations of the Earth System Documentation',
u'Paul Gierz', 'manual'),
(
master_doc,
"scope.tex",
u"SCOPE: A Script Based Coupler for Simulations of the Earth System Documentation",
u"Paul Gierz",
"manual",
)
]
......@@ -154,9 +156,13 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'scope',
u'SCOPE: A Script Based Coupler for Simulations of the Earth System Documentation',
[author], 1)
(
master_doc,
"scope",
u"SCOPE: A Script Based Coupler for Simulations of the Earth System Documentation",
[author],
1,
)
]
......@@ -166,13 +172,13 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'scope',
u'SCOPE: A Script Based Coupler for Simulations of the Earth System Documentation',
author,
'scope',
'One line description of project.',
'Miscellaneous'),
(
master_doc,
"scope",
u"SCOPE: A Script Based Coupler for Simulations of the Earth System Documentation",
author,
"scope",
"One line description of project.",
"Miscellaneous",
)
]
Modules & Code Documentation
============================
scope
=====
This section shows source code documentation.
.. toctree::
:maxdepth: 4
.. automodule:: scope
:members:
:undoc-members:
:show-inheritance:
scope
scope package
=============
Submodules
----------
scope.cli module
----------------
.. automodule:: scope.cli
:members:
:undoc-members:
:show-inheritance:
scope.models module
-------------------
.. automodule:: scope.models
:members:
:undoc-members:
:show-inheritance:
scope.scope module
------------------
.. automodule:: scope.scope
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. 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