|
1 | | -# Configuration file for the Sphinx documentation builder. |
2 | | -# |
3 | | -# This file only contains a selection of the most common options. For a full |
4 | | -# list see the documentation: |
5 | | -# https://www.sphinx-doc.org/en/master/usage/configuration.html |
6 | | - |
7 | | -# -- Path setup -------------------------------------------------------------- |
8 | | - |
9 | | -# If extensions (or modules to document with autodoc) are in another directory, |
10 | | -# add these directories to sys.path here. If the directory is relative to the |
11 | | -# documentation root, use os.path.abspath to make it absolute, like shown here. |
12 | | -# |
13 | | -# import os |
14 | | -# import sys |
15 | | -# sys.path.insert(0, os.path.abspath('.')) |
16 | | - |
17 | | - |
18 | | -# -- Project information ----------------------------------------------------- |
19 | | - |
20 | | -project = 'aboutcode-toolkit' |
21 | | -copyright = 'nexb Inc.' |
22 | | -author = 'nexb Inc.' |
23 | | - |
24 | | - |
25 | | -# -- General configuration --------------------------------------------------- |
26 | | - |
27 | | -# Add any Sphinx extension module names here, as strings. They can be |
28 | | -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
29 | | -# ones. |
30 | | -extensions = [ |
31 | | -'sphinx.ext.intersphinx', |
32 | | -] |
33 | | - |
34 | | -# Add any paths that contain templates here, relative to this directory. |
35 | | -templates_path = ['_templates'] |
36 | | - |
37 | | -# List of patterns, relative to source directory, that match files and |
38 | | -# directories to ignore when looking for source files. |
39 | | -# This pattern also affects html_static_path and html_extra_path. |
40 | | -exclude_patterns = [] |
41 | | - |
42 | | -master_doc = 'index' |
43 | | - |
44 | | -# -- Options for HTML output ------------------------------------------------- |
45 | | - |
46 | | -# The theme to use for HTML and HTML Help pages. See the documentation for |
47 | | -# a list of builtin themes. |
48 | | -# |
49 | | -html_theme = 'sphinx_rtd_theme' |
50 | | - |
51 | | -# Add any paths that contain custom static files (such as style sheets) here, |
52 | | -# relative to this directory. They are copied after the builtin static files, |
53 | | -# so a file named "default.css" will overwrite the builtin "default.css". |
54 | | -html_static_path = ['_static'] |
55 | | - |
56 | | -html_context = { |
57 | | - "display_github": True, |
58 | | - "github_user": "nexB", |
59 | | - "github_repo": "aboutcode-toolkit", |
60 | | - "github_version": "develop", # branch |
61 | | - "conf_py_path": "/docs/source/", # path in the checkout to the docs root |
62 | | - } |
63 | | - |
64 | | -html_css_files = [ |
65 | | - '_static/theme_overrides.css' |
| 1 | +# Configuration file for the Sphinx documentation builder. |
| 2 | +# |
| 3 | +# This file only contains a selection of the most common options. For a full |
| 4 | +# list see the documentation: |
| 5 | +# https://www.sphinx-doc.org/en/master/usage/configuration.html |
| 6 | + |
| 7 | +# -- Path setup -------------------------------------------------------------- |
| 8 | + |
| 9 | +# If extensions (or modules to document with autodoc) are in another directory, |
| 10 | +# add these directories to sys.path here. If the directory is relative to the |
| 11 | +# documentation root, use os.path.abspath to make it absolute, like shown here. |
| 12 | +# |
| 13 | +# import os |
| 14 | +# import sys |
| 15 | +# sys.path.insert(0, os.path.abspath('.')) |
| 16 | + |
| 17 | + |
| 18 | +# -- Project information ----------------------------------------------------- |
| 19 | + |
| 20 | +project = 'aboutcode-toolkit' |
| 21 | +copyright = 'nexb Inc.' |
| 22 | +author = 'nexb Inc.' |
| 23 | + |
| 24 | + |
| 25 | +# -- General configuration --------------------------------------------------- |
| 26 | + |
| 27 | +# Add any Sphinx extension module names here, as strings. They can be |
| 28 | +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
| 29 | +# ones. |
| 30 | +extensions = [ |
| 31 | +'sphinx.ext.intersphinx', |
| 32 | +] |
| 33 | + |
| 34 | +# Add any paths that contain templates here, relative to this directory. |
| 35 | +templates_path = ['_templates'] |
| 36 | + |
| 37 | +# List of patterns, relative to source directory, that match files and |
| 38 | +# directories to ignore when looking for source files. |
| 39 | +# This pattern also affects html_static_path and html_extra_path. |
| 40 | +exclude_patterns = [] |
| 41 | + |
| 42 | +master_doc = 'index' |
| 43 | + |
| 44 | +# -- Options for HTML output ------------------------------------------------- |
| 45 | + |
| 46 | +# The theme to use for HTML and HTML Help pages. See the documentation for |
| 47 | +# a list of builtin themes. |
| 48 | +# |
| 49 | +html_theme = 'sphinx_rtd_theme' |
| 50 | + |
| 51 | +# Add any paths that contain custom static files (such as style sheets) here, |
| 52 | +# relative to this directory. They are copied after the builtin static files, |
| 53 | +# so a file named "default.css" will overwrite the builtin "default.css". |
| 54 | +html_static_path = ['_static'] |
| 55 | + |
| 56 | +html_context = { |
| 57 | + "display_github": True, |
| 58 | + "github_user": "nexB", |
| 59 | + "github_repo": "aboutcode-toolkit", |
| 60 | + "github_version": "develop", # branch |
| 61 | + "conf_py_path": "/docs/source/", # path in the checkout to the docs root |
| 62 | + } |
| 63 | + |
| 64 | +html_css_files = [ |
| 65 | + '_static/theme_overrides.css' |
66 | 66 | ] |
0 commit comments