|
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 |
| 1 | +import os |
| 2 | +import sys |
| 3 | +import datetime |
6 | 4 |
|
7 | 5 | # -- Path setup -------------------------------------------------------------- |
8 | 6 |
|
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 | | - |
| 7 | +sys.path.insert(0, os.path.abspath('..')) |
17 | 8 |
|
18 | 9 | # -- Project information ----------------------------------------------------- |
19 | 10 |
|
20 | | -project = "jsonrpcserver" |
21 | | -copyright = "2021, Beau Barker" |
22 | | -author = "Beau Barker" |
23 | | - |
24 | | -# The full version, including alpha/beta/rc tags |
25 | | -release = "5.0.0" |
26 | | - |
| 11 | +project = 'jsonrpcserver' |
| 12 | +author = 'Exploding Labs' |
| 13 | +copyright = f'{datetime.datetime.now().year}, {author}' |
| 14 | +release = '5.0.9' # Or dynamically read from package metadata |
27 | 15 |
|
28 | 16 | # -- General configuration --------------------------------------------------- |
29 | 17 |
|
30 | | -# Add any Sphinx extension module names here, as strings. They can be |
31 | | -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
32 | | -# ones. |
33 | | -extensions = ["sphinx_rtd_theme", "myst_parser"] |
| 18 | +extensions = [ |
| 19 | + 'sphinx.ext.autodoc', |
| 20 | + 'sphinx.ext.napoleon', # for Google/NumPy docstrings |
| 21 | + 'sphinx.ext.viewcode', |
| 22 | +] |
34 | 23 |
|
35 | | -# Add any paths that contain templates here, relative to this directory. |
36 | | -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. |
| 24 | +templates_path = ['_templates'] |
41 | 25 | exclude_patterns = [] |
42 | 26 |
|
43 | | - |
44 | 27 | # -- Options for HTML output ------------------------------------------------- |
45 | 28 |
|
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 | | -html_theme_options = { |
51 | | - "analytics_id": "G-G05775CD6C", # UA-81795603-3 |
52 | | - "display_version": True, |
53 | | -} |
54 | | - |
55 | | -# Add any paths that contain custom static files (such as style sheets) here, |
56 | | -# relative to this directory. They are copied after the builtin static files, |
57 | | -# so a file named "default.css" will overwrite the builtin "default.css". |
58 | | -html_static_path = ["_static"] |
59 | | - |
60 | | -source_suffix = [".rst", ".md"] |
61 | | -html_show_sourcelink = False |
| 29 | +html_theme = 'sphinx_rtd_theme' |
| 30 | +html_static_path = ['_static'] |
0 commit comments