Commit dd80d59d authored by Theo Steininger's avatar Theo Steininger

Fixed bugs in docs and switched to rtd theme.

parent e742b47c
Pipeline #12922 passed with stages
in 11 minutes and 23 seconds
...@@ -17,6 +17,10 @@ import sys ...@@ -17,6 +17,10 @@ import sys
import os import os
import sphinx_rtd_theme
# If extensions (or modules to document with autodoc) are in another directory, # 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 # 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. # documentation root, use os.path.abspath to make it absolute, like shown here.
...@@ -77,7 +81,7 @@ master_doc = 'index' ...@@ -77,7 +81,7 @@ master_doc = 'index'
# General information about the project. # General information about the project.
project = u'NIFTY' project = u'NIFTY'
copyright = u'2017, Theo Steininger' copyright = u'2013-2017, Max-Planck-Society'
author = u'Theo Steininger' author = u'Theo Steininger'
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
...@@ -138,13 +142,28 @@ todo_include_todos = True ...@@ -138,13 +142,28 @@ todo_include_todos = True
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
html_theme = 'alabaster'
#html_theme = 'classic' html_theme = "sphinx_rtd_theme"
html_theme_options = { html_theme_options = {
'page_width':'' 'collapse_navigation': False,
'display_version': False,
'navigation_depth': 3,
} }
#html_theme = 'alabaster'
#html_theme_options = {
# 'page_width':''
#}
#html_theme = 'classic'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# Theme options are theme-specific and customize the look and feel of a theme # 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 # further. For a list of options available for each theme, see the
...@@ -163,7 +182,7 @@ html_theme_options = { ...@@ -163,7 +182,7 @@ html_theme_options = {
# The name of an image file (relative to this directory) to place at the top # The name of an image file (relative to this directory) to place at the top
# of the sidebar. # of the sidebar.
html_logo = 'nifty_logo_black.png' html_logo = 'nifty_logo_white.png'
# The name of an image file (relative to this directory) to use as a favicon of # The name of an image file (relative to this directory) to use as a favicon of
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
......
...@@ -3,6 +3,6 @@ ...@@ -3,6 +3,6 @@
The ``EndomorphicOperator`` class -- ... The ``EndomorphicOperator`` class -- ...
........................................ ........................................
.. autoclass:: EnomorphicOperator .. autoclass:: EndomorphicOperator
:show-inheritance: :show-inheritance:
:members: :members:
.. currentmodule:: nifty
The ``Transform`` class -- A transformation routine
...................................................
.. autoclass:: Transform
:show-inheritance:
:members:
...@@ -5,7 +5,6 @@ NIFTY provides transformations ...@@ -5,7 +5,6 @@ NIFTY provides transformations
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
rg_transforms
rgrg_transformation rgrg_transformation
gllm_transformation gllm_transformation
hplm_transformation hplm_transformation
......
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