|
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 | 1 | project = "Python-LabThings" |
21 | 2 | copyright = "2020, Joel Collins" |
22 | 3 | author = "Joel Collins" |
23 | 4 |
|
24 | 5 |
|
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 | 6 | extensions = [ |
31 | 7 | "autoapi.extension", |
32 | 8 | "sphinx_rtd_theme", |
33 | 9 | ] |
34 | 10 |
|
35 | | -# Add any paths that contain templates here, relative to this directory. |
36 | 11 | templates_path = ["_templates"] |
37 | | - |
38 | | -# List of patterns, relative to source directory, that match files and |
39 | | -# directories to ignore when looking for source files. |
40 | | -# This pattern also affects html_static_path and html_extra_path. |
41 | 12 | exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
42 | 13 |
|
| 14 | +master_doc = "index" |
43 | 15 |
|
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 | 16 | 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 | 17 | html_static_path = ["_static"] |
55 | 18 |
|
56 | | -# AutoAPI |
57 | 19 | autoapi_dirs = ["../src/labthings"] |
58 | 20 | autoapi_ignore = [ |
59 | 21 | "*/server/*", |
|
0 commit comments