diff options
author | Sander Vrijders <sander.vrijders@ugent.be> | 2018-03-26 16:25:14 +0200 |
---|---|---|
committer | Sander Vrijders <sander.vrijders@ugent.be> | 2018-03-28 16:41:40 +0200 |
commit | a1bddf0ab2cd7bee30b1f0dc1575c0b8c532e157 (patch) | |
tree | 65172a461889ca93053187494a565423a54f112e /doc/conf.py | |
parent | a95c3b376053ed00f0e7184dbd228598a9aaf50f (diff) | |
download | rumba-a1bddf0ab2cd7bee30b1f0dc1575c0b8c532e157.tar.gz rumba-a1bddf0ab2cd7bee30b1f0dc1575c0b8c532e157.zip |
rumba: Add Rumba documentation website
This adds a documentation website for Rumba which is triggered
automatically after changes to master.
Diffstat (limited to 'doc/conf.py')
-rw-r--r-- | doc/conf.py | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/doc/conf.py b/doc/conf.py new file mode 100644 index 0000000..0424dc7 --- /dev/null +++ b/doc/conf.py @@ -0,0 +1,41 @@ +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' + ] +} + +project = 'Rumba' +year = datetime.now().year +copyright = '{} imec, Nextworks S.r.l.'.format(year) +author = 'Sander Vrijders, Marco Capitani, Dimitri Staessens, Vincenzo Maffione' +master_doc = 'index' +source_suffix = '.rst' +default_role = 'obj' +language = None + +extensions.extend(['sphinx.ext.autodoc']) +autodoc_default_flags = ['members', 'special-members'] + +_locals = {} +with open('../rumba/_version.py') as fp: + exec(fp.read(), None, _locals) +version = _locals['__version__'] + +version = version +release = version |