Skip to content
Snippets Groups Projects
Select Git revision
  • main default protected
  • bump-django-basetheme-bootstrap
  • master protected
  • speed-up-import
  • cronjob-wait-db
  • download-png
  • v0.0.1_apache_postgres_django
7 results
Blame Permalink
conf.py 2.64 KiB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81 






# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Path setup --------------------------------------------------------------

# 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.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))


# -- Project information -----------------------------------------------------

project = 'Viral Host Range database'
copyright = '2019, Bryan Brancotte'
author = 'Bryan Brancotte'
github_doc_root = 'https://gitlab.pasteur.fr/hub/12765-viralhostrangedb/doc'

# The full version, including alpha/beta/rc tags
release = '1.0'


# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.coverage',
    'sphinx.ext.viewcode',
    'sphinx.ext.autosummary',
    # The Napoleon extension allows for nicer argument formatting.
    'sphinx.ext.napoleon',
    'sphinxarg.ext',
    'sphinxcontrib.bibtex',
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_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".
html_static_path = ['_static']


# html_show_sourcelink = False

#html_theme_options = {
#    'gitlab_url' : 'https://gitlab.pasteur.fr',
#}

html_context = {
    "display_gitlab": True, # Integrate Gitlab
    "gitlab_user": "hub", # Username
    "gitlab_host": "gitlab.pasteur.fr",
    "gitlab_repo": "12765-viralhostrangedb", # Repo name
    "gitlab_version": "master", # Version
    "conf_py_path": "/doc/", # Path in the checkout to the docs root
}