oemof /
oemof-network
| Total Complexity | 0 |
| Total Lines | 50 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
| 1 | # -*- coding: utf-8 -*- |
||
| 2 | from __future__ import unicode_literals |
||
| 3 | |||
| 4 | import os |
||
| 5 | |||
| 6 | extensions = [ |
||
| 7 | "sphinx.ext.autodoc", |
||
| 8 | "sphinx.ext.autosummary", |
||
| 9 | "sphinx.ext.coverage", |
||
| 10 | "sphinx.ext.doctest", |
||
| 11 | "sphinx.ext.extlinks", |
||
| 12 | "sphinx.ext.ifconfig", |
||
| 13 | "sphinx.ext.napoleon", |
||
| 14 | "sphinx.ext.todo", |
||
| 15 | "sphinx.ext.viewcode", |
||
| 16 | ] |
||
| 17 | source_suffix = ".rst" |
||
| 18 | master_doc = "index" |
||
| 19 | project = "oemof.network" |
||
| 20 | year = "2020" |
||
| 21 | author = "Stephan Günther" |
||
| 22 | copyright = "{0}, {1}".format(year, author) |
||
| 23 | version = release = "0.4.0rc0" |
||
| 24 | |||
| 25 | pygments_style = "trac" |
||
| 26 | templates_path = ["."] |
||
| 27 | extlinks = { |
||
| 28 | "issue": ("https://github.com/oemof/oemof.network/issues/%s", "#"), |
||
| 29 | "pr": ("https://github.com/oemof/oemof.network/pull/%s", "PR #"), |
||
| 30 | } |
||
| 31 | # on_rtd is whether we are on readthedocs.org |
||
| 32 | on_rtd = os.environ.get("READTHEDOCS", None) == "True" |
||
| 33 | |||
| 34 | if not on_rtd: # only set the theme if we're building docs locally |
||
| 35 | html_theme = "sphinx_rtd_theme" |
||
| 36 | |||
| 37 | html_use_smartypants = True |
||
| 38 | html_last_updated_fmt = "%b %d, %Y" |
||
| 39 | html_split_index = False |
||
| 40 | html_sidebars = { |
||
| 41 | "**": ["searchbox.html", "globaltoc.html", "sourcelink.html"], |
||
| 42 | } |
||
| 43 | html_short_title = "%s-%s" % (project, version) |
||
| 44 | |||
| 45 | napoleon_use_ivar = True |
||
| 46 | napoleon_use_rtype = False |
||
| 47 | napoleon_use_param = False |
||
| 48 | |||
| 49 | linkcheck_ignore = [r"https://requires.io/.*"] |
||
| 50 |
