aboutsummaryrefslogtreecommitdiff
path: root/doc/conf.py
diff options
context:
space:
mode:
authorSander Vrijders <sander.vrijders@ugent.be>2018-03-28 17:42:03 +0200
committerSander Vrijders <sander.vrijders@ugent.be>2018-03-28 18:20:36 +0200
commit74265717dcb72ee5e6abf54f7b67ba9d2658e0ed (patch)
treedae0a2c7208a9114292988fb02d2366834061136 /doc/conf.py
parente694075c7fdcc9c4579d55b792da7a1391401b35 (diff)
downloadrumba-74265717dcb72ee5e6abf54f7b67ba9d2658e0ed.tar.gz
rumba-74265717dcb72ee5e6abf54f7b67ba9d2658e0ed.zip
model: Add docstrings to model
This adds docstrings to the model so that Sphinx can parse them. It also adds some changes to the rst files and conf.py so that inherited members are shown and special members are not.
Diffstat (limited to 'doc/conf.py')
-rw-r--r--doc/conf.py25
1 files changed, 5 insertions, 20 deletions
diff --git a/doc/conf.py b/doc/conf.py
index 0424dc7..988dbf7 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -1,24 +1,7 @@
from datetime import datetime
-import alabaster
-
-
-html_theme_path = [alabaster.get_path()]
-extensions = ['alabaster']
-html_theme = 'alabaster'
-
-html_theme_options = {
- 'description': "Rumba: A framework to bootstrap a " +
- "recursive internet network on a testbed."
-}
-
-html_sidebars = {
- '**': [
- 'about.html',
- 'navigation.html',
- 'searchbox.html'
- ]
-}
+html_theme = "agogo"
+extensions = []
project = 'Rumba'
year = datetime.now().year
@@ -30,7 +13,9 @@ default_role = 'obj'
language = None
extensions.extend(['sphinx.ext.autodoc'])
-autodoc_default_flags = ['members', 'special-members']
+autodoc_default_flags = ['members']
+
+autoclass_content = 'both'
_locals = {}
with open('../rumba/_version.py') as fp: