X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=docs%2Fconf.py;h=a95ec040a276c8187c1020690b2f02c06dedb495;hb=17b26ef759a99c9010ea30e47205bfb332400e74;hp=2c556729d23e9e55c6783f4be2bd5c63db0d1c48;hpb=17b45c65afac23a123e66834f93049a1c7e45201;p=osm%2FN2VC.git diff --git a/docs/conf.py b/docs/conf.py index 2c55672..a95ec04 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -15,6 +15,11 @@ import sys import os +from pathlib import Path + +here = Path(__file__).absolute().parent +version = (here.parent / 'VERSION').read_text().strip() + # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. @@ -28,10 +33,15 @@ sys.path.insert(0, os.path.abspath('..')) # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. +sys.path.append(os.path.abspath('_extensions/')) extensions = [ 'sphinx.ext.autodoc', + 'sphinx.ext.autosummary', + 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.viewcode', + 'sphinxcontrib.asyncio', + 'automembersummary', ] # Add any paths that contain templates here, relative to this directory. @@ -49,8 +59,8 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'libjuju' -copyright = u'2016, Canonical' +project = u'juju' +copyright = u'2016, Canonical Ltd.' author = u'Canonical' # The version info for the project you're documenting, acts as replacement for @@ -58,9 +68,9 @@ author = u'Canonical' # built documents. # # The short X.Y version. -version = u'0.0.0' +version = version # The full version, including alpha/beta/rc tags. -release = u'0.0.0' +release = version # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -112,7 +122,7 @@ todo_include_todos = True # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -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 @@ -288,3 +298,6 @@ texinfo_documents = [ # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False + +def setup(app): + app.add_stylesheet('custom.css')