1
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
2
6
3
7
# -- Path setup --------------------------------------------------------------
4
8
5
- import os
6
- import sys
7
- sys .path .insert (0 , os .path .abspath ('..' ))
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
+
8
17
9
18
# -- Project information -----------------------------------------------------
10
19
11
- project = 'omnivista_py'
12
- copyright = '2024, Phillip Jerome Yosief'
13
- author = 'Phillip Jerome Yosief'
20
+ project = "Basic Sphinx Example Project"
21
+ copyright = "2022, Read the Docs core team"
22
+ author = "Read the Docs core team"
14
23
15
- # The full version, including alpha/beta/rc tags
16
- release = '0.3.8'
17
24
18
25
# -- General configuration ---------------------------------------------------
26
+ # -- General configuration
19
27
20
28
extensions = [
21
- 'sphinx.ext.autodoc' ,
22
- 'sphinx.ext.napoleon' ,
23
- 'sphinx_autodoc_typehints' ,
29
+ "sphinx.ext.duration" ,
30
+ "sphinx.ext.doctest" ,
31
+ "sphinx.ext.autodoc" ,
32
+ "sphinx.ext.autosummary" ,
33
+ "sphinx.ext.intersphinx" ,
24
34
]
25
35
26
- templates_path = ['_templates' ]
27
- exclude_patterns = []
36
+ intersphinx_mapping = {
37
+ "rtd" : ("https://docs.readthedocs.io/en/stable/" , None ),
38
+ "python" : ("https://docs.python.org/3/" , None ),
39
+ "sphinx" : ("https://www.sphinx-doc.org/en/master/" , None ),
40
+ }
41
+ intersphinx_disabled_domains = ["std" ]
42
+
43
+ templates_path = ["_templates" ]
44
+
45
+ # -- Options for EPUB output
46
+ epub_show_urls = "footnote"
47
+
48
+ # List of patterns, relative to source directory, that match files and
49
+ # directories to ignore when looking for source files.
50
+ # This pattern also affects html_static_path and html_extra_path.
51
+ exclude_patterns = ["_build" , "Thumbs.db" , ".DS_Store" ]
28
52
29
53
# -- Options for HTML output -------------------------------------------------
30
54
31
- html_theme = 'sphinx_rtd_theme'
32
- html_static_path = ['_static' ]
55
+ # The theme to use for HTML and HTML Help pages. See the documentation for
56
+ # a list of builtin themes.
57
+ #
58
+ html_theme = "sphinx_rtd_theme"
59
+
60
+ # Add any paths that contain custom static files (such as style sheets) here,
61
+ # relative to this directory. They are copied after the builtin static files,
62
+ # so a file named "default.css" will overwrite the builtin "default.css".
63
+ html_static_path = ["_static" ]
0 commit comments