|
1 | 1 | # Configuration file for the Sphinx documentation builder.
|
2 | 2 | #
|
3 |
| -# This file only contains a selection of the most common options. For a full |
4 |
| -# list see the documentation: |
| 3 | +# For the full list of built-in configuration values, see the documentation: |
5 | 4 | # https://www.sphinx-doc.org/en/master/usage/configuration.html
|
6 | 5 |
|
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 | 6 | import sys
|
| 7 | +from pathlib import Path |
15 | 8 |
|
16 |
| -sys.path.insert(0, os.path.abspath("..")) |
17 |
| - |
| 9 | +sys.path.insert(0, str(Path(__file__).parent.parent)) |
18 | 10 |
|
19 | 11 | # -- Project information -----------------------------------------------------
|
| 12 | +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information |
20 | 13 |
|
21 | 14 | project = "OCDS Data Review Tool"
|
22 | 15 | copyright = "2020, Open Contracting Partnership and Open Data Services Co-operative Limited"
|
23 | 16 | author = "Open Contracting Partnership and Open Data Services Co-operative Limited"
|
24 | 17 |
|
25 |
| - |
26 | 18 | # -- General configuration ---------------------------------------------------
|
| 19 | +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration |
27 | 20 |
|
28 |
| -# Add any Sphinx extension module names here, as strings. They can be |
29 |
| -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
30 |
| -# ones. |
31 | 21 | extensions = [
|
32 | 22 | "sphinx.ext.autodoc",
|
33 | 23 | "sphinx.ext.viewcode",
|
34 | 24 | ]
|
35 | 25 |
|
36 |
| -# Add any paths that contain templates here, relative to this directory. |
37 | 26 | templates_path = ["_templates"]
|
38 |
| - |
39 |
| -# List of patterns, relative to source directory, that match files and |
40 |
| -# directories to ignore when looking for source files. |
41 |
| -# This pattern also affects html_static_path and html_extra_path. |
42 | 27 | exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
|
43 | 28 |
|
44 |
| - |
45 | 29 | # -- Options for HTML output -------------------------------------------------
|
| 30 | +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output |
46 | 31 |
|
47 |
| -# The theme to use for HTML and HTML Help pages. See the documentation for |
48 |
| -# a list of builtin themes. |
49 |
| -# |
50 | 32 | html_theme = "furo"
|
51 |
| - |
52 |
| -# Add any paths that contain custom static files (such as style sheets) here, |
53 |
| -# relative to this directory. They are copied after the builtin static files, |
54 |
| -# so a file named "default.css" will overwrite the builtin "default.css". |
55 | 33 | html_static_path = []
|
56 | 34 |
|
57 |
| - |
58 | 35 | # -- Extension configuration -------------------------------------------------
|
59 | 36 |
|
60 | 37 | autodoc_default_options = {
|
|
0 commit comments