From 31df0bbbb2cbbb1a6b833b3334ea187d809cb172 Mon Sep 17 00:00:00 2001
From: "benjamin.jakimow" <benjamin.jakimow@geo.hu-berlin.de>
Date: Fri, 27 Apr 2018 16:02:28 +0200
Subject: [PATCH] changed documentation conf.py, added sphinx requirements
---
doc/source/conf.py | 23 +++++++++++++++++++++--
doc/source/requirements.txt | 6 ++++++
2 files changed, 27 insertions(+), 2 deletions(-)
create mode 100644 doc/source/requirements.txt
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 59203625..14dfd569 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -39,7 +39,8 @@ extensions = ['sphinx.ext.autodoc',
'sphinx.ext.mathjax',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
- 'sphinx.ext.autosectionlabel']
+ 'sphinx.ext.autosectionlabel'
+ ]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -96,7 +97,25 @@ todo_include_todos = True
#
#html_theme = 'alabaster'
html_theme = 'sphinx_rtd_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
+# documentation.
+#
+html_theme_options = {
+ 'canonical_url': '',
+ 'analytics_id': '',
+ 'logo_only': False,
+ 'display_version': True,
+ 'prev_next_buttons_location': 'bottom',
+ 'style_external_links': False,
+ 'vcs_pageview_mode': 'view',
+ # Toc options
+ 'collapse_navigation': True,
+ 'sticky_navigation': True,
+ 'navigation_depth': 4,
+ 'includehidden': True,
+ 'titles_only': False
+}
html_logo = 'img/logo.png'
# Theme options are theme-specific and customize the look and feel of a theme
diff --git a/doc/source/requirements.txt b/doc/source/requirements.txt
new file mode 100644
index 00000000..85396b15
--- /dev/null
+++ b/doc/source/requirements.txt
@@ -0,0 +1,6 @@
+# this file lists packages that are required to run Sphinx
+# see https://pip.pypa.io/en/stable/reference/pip_install/#requirements-file-format
+
+###### Requirements to build documentation with sphinx ######
+sphinx>=1.7.2
+sphinx_rtd_theme>=0.3.0
\ No newline at end of file
--
GitLab