From 74265717dcb72ee5e6abf54f7b67ba9d2658e0ed Mon Sep 17 00:00:00 2001 From: Sander Vrijders Date: Wed, 28 Mar 2018 17:42:03 +0200 Subject: 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. --- doc/conf.py | 25 +++++-------------------- 1 file changed, 5 insertions(+), 20 deletions(-) (limited to 'doc/conf.py') 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: -- cgit v1.2.3