docs/conf.py · rel8 · git.iko.soy

on 137ebed help sign in

rel8/docs/conf.py

36 lines 802 B history raw

1import sys

2import os

3import sphinx_rtd_theme

5# Support for :base-ref:, etc.

6sys.path.insert(0, os.path.abspath('.'))

8version = "1.0.0"

10extensions = ['sphinx.ext.extlinks', 'sphinx.ext.todo', 'sphinx_rtd_theme']

12templates_path = ['_templates']

13source_suffix = '.rst'

14source_encoding = 'utf-8-sig'

15master_doc = 'index'

17project = u'Rel8'

18copyright = u'2021 CircuitHub'

19release = version

21highlight_language = 'haskell'

22primary_domain = 'haskell'

24exclude_patterns = ['.build', "*.gen.rst"]

26html_theme = 'sphinx_rtd_theme'

27html_theme_options = {

28 'logo_only': True,

29 'navigation_depth': 5,

31html_context = {}

33# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org

34on_rtd = os.environ.get('READTHEDOCS', None) == 'True'

36todo_include_todos = True