diff options
author | umarcor <unai.martinezcorral@ehu.eus> | 2020-08-31 00:59:22 +0200 |
---|---|---|
committer | tgingold <tgingold@users.noreply.github.com> | 2020-08-31 08:08:31 +0200 |
commit | 1c00b4812edb439f47938d074b9c4f73b2cc0ad3 (patch) | |
tree | 816fbcbb65594081b54c27c082c5dcc66f467889 /doc/conf.py | |
parent | e3672365cf95b98135c2b65446995dcd85b92d5e (diff) | |
download | ghdl-1c00b4812edb439f47938d074b9c4f73b2cc0ad3.tar.gz ghdl-1c00b4812edb439f47938d074b9c4f73b2cc0ad3.tar.bz2 ghdl-1c00b4812edb439f47938d074b9c4f73b2cc0ad3.zip |
ci: use buildthedocs/btd to build and publish the docs to GHP
Diffstat (limited to 'doc/conf.py')
-rw-r--r-- | doc/conf.py | 31 |
1 files changed, 17 insertions, 14 deletions
diff --git a/doc/conf.py b/doc/conf.py index 69ff6f139..dff335e4d 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -1,7 +1,10 @@ # -*- coding: utf-8 -*- import sys, re -from os.path import abspath, join +from os.path import abspath +from pathlib import Path +from json import dump, loads + # 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 @@ -35,7 +38,7 @@ autodoc_default_options = { 'inherited-members': True, } -templates_path = ['_templates', '_themes'] +templates_path = ['_templates'] # The suffix(es) of source filenames. source_suffix = { @@ -80,9 +83,6 @@ language = None # directories to ignore when looking for source files. exclude_patterns = [] -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = True todo_link_only = True @@ -99,17 +99,20 @@ except Exception as ex: # -- Options for HTML output ---------------------------------------------- -html_theme = "sphinx_rtd_theme" - -# Override default css to get a larger width for ReadTheDoc build -html_context = { - 'css_files': [ - 'https://media.readthedocs.org/css/sphinx_rtd_theme.css', - 'https://media.readthedocs.org/css/readthedocs-doc-embed.css', - '_static/theme_overrides.css', - ], +html_theme_options = { + 'logo_only': True, + 'home_breadcrumbs': False, + 'vcs_pageview_mode': 'blob', } +html_context = {} +ctx = Path(__file__).resolve().parent / 'context.json' +if ctx.is_file(): + html_context.update(loads(ctx.open('r').read())) + +html_theme_path = ["."] +html_theme = "_theme" + # 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". |