diff options
Diffstat (limited to 'docs/source/conf.py')
| -rw-r--r-- | docs/source/conf.py | 38 |
1 files changed, 18 insertions, 20 deletions
diff --git a/docs/source/conf.py b/docs/source/conf.py index 20b4443..80e16b9 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -12,8 +12,6 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import os - # 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. @@ -30,9 +28,7 @@ import os extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.napoleon', - 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', - 'sphinx.ext.todo' ] # Add any paths that contain templates here, relative to this directory. @@ -50,8 +46,7 @@ source_suffix = '.rst' master_doc = 'contents' # General information about the project. -project = u'PyASN1' -# noinspection PyShadowingBuiltins +project = u'ASN.1 types and codecs' copyright = u'2005-2017, Ilya Etingof <etingof@gmail.com>' author = u'Ilya Etingof <etingof@gmail.com>' @@ -60,9 +55,9 @@ author = u'Ilya Etingof <etingof@gmail.com>' # built documents. # # The short X.Y version. -version = '0.3' +version = '0.4' # The full version, including alpha/beta/rc tags. -release = '0.3.1' +release = '0.4' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -106,7 +101,7 @@ pygments_style = 'sphinx' # keep_warnings = False # If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = True +todo_include_todos = False # -- Options for HTML output ---------------------------------------------- @@ -118,20 +113,30 @@ html_theme = 'alabaster' # further. For a list of options available for each theme, see the # documentation. html_theme_options = { - 'description': 'ASN.1 types and codecs', + 'logo': 'logo.svg', + 'description': '<p align=center><i>Brought by SNMP Labs</i></p>', 'show_powered_by': False, 'github_user': 'etingof', 'github_repo': 'pyasn1', 'fixed_sidebar': True, } +html_sidebars = { + '**': [ + 'about.html', + 'navigation.html', + 'relations.html', + 'searchbox.html', + 'donate.html', + ] +} + # Add any paths that contain custom themes here, relative to this directory. # html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # "<project> v<release> documentation". # html_title = None -html_title = "PyASN1" # A shorter title for the navigation bar. Default is the same as html_title. # html_short_title = None @@ -143,17 +148,12 @@ html_title = "PyASN1" # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -# html_favicon = None +html_favicon = '.static/favicon.ico' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -# if 'PYASN1DEV' in os.environ: -# html_static_path = ['.static'] -# -# # Custom CSS theme -# if 'PYASN1DEV' in os.environ: -# html_style = 'css/rtdimproved.css' +html_static_path = ['.static'] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied @@ -324,5 +324,3 @@ napoleon_use_admonition_for_references = False napoleon_use_ivar = False napoleon_use_param = False napoleon_use_rtype = False - -# Alabaster theme
\ No newline at end of file |