|
28 | 28 | # add these directories to sys.path here. |
29 | 29 | import sys |
30 | 30 | import os |
31 | | -sys.path.insert(0, os.path.abspath('../..')) |
32 | 31 |
|
33 | | -#import pathlib |
34 | | -#sys.path.insert(0, pathlib.Path(__file__).parents[2].resolve().as_posix()) |
| 32 | +sys.path.insert(0, os.path.abspath("../..")) |
| 33 | + |
| 34 | +# import pathlib |
| 35 | +# sys.path.insert(0, pathlib.Path(__file__).parents[2].resolve().as_posix()) |
35 | 36 |
|
36 | 37 | # -- Project information |
37 | 38 |
|
38 | | -project = 'TorchQuantum' |
39 | | -copyright = '2021, Hanrui Wang' |
40 | | -author = 'Hanrui Wang' |
| 39 | +project = "TorchQuantum" |
| 40 | +copyright = "2021, Hanrui Wang" |
| 41 | +author = "Hanrui Wang" |
41 | 42 |
|
42 | | -release = '0.1' |
43 | | -version = '0.1.0' |
| 43 | +release = "0.1" |
| 44 | +version = "0.1.0" |
44 | 45 |
|
45 | 46 | # -- General configuration |
46 | 47 |
|
47 | 48 | extensions = [ |
48 | | - 'sphinx.ext.duration', |
49 | | - 'sphinx.ext.doctest', |
50 | | - 'sphinx.ext.autodoc', |
51 | | - 'sphinx.ext.autosummary', |
52 | | - 'sphinx.ext.intersphinx', |
53 | | - 'sphinx.ext.napoleon', # google styled docstring |
54 | | - 'sphinx.ext.viewcode', # [source] link to view code |
| 49 | + "sphinx.ext.duration", |
| 50 | + "sphinx.ext.doctest", |
| 51 | + "sphinx.ext.autodoc", |
| 52 | + "sphinx.ext.autosummary", |
| 53 | + "sphinx.ext.intersphinx", |
| 54 | + "sphinx.ext.napoleon", # google styled docstring |
| 55 | + "sphinx.ext.viewcode", # [source] link to view code |
55 | 56 | # 'sphinx.ext.todo', |
56 | 57 | # 'sphinx.ext.coverage', |
57 | 58 | # 'sphinxcontrib.katex', |
|
62 | 63 | # 'sphinx.ext.extlinks', |
63 | 64 | # 'sphinx_autodoc_typehints', |
64 | 65 | # 'jupyter_sphinx', |
65 | | - 'nbsphinx', # support for including Jupyter Notebook (*.ipynb) file |
66 | | - 'recommonmark', # support for including markdown (*.md) file |
| 66 | + "nbsphinx", # support for including Jupyter Notebook (*.ipynb) file |
| 67 | + "recommonmark", # support for including markdown (*.md) file |
67 | 68 | # 'sphinx_design', |
68 | 69 | # 'sphinx_reredirects' |
69 | 70 | ] |
70 | 71 |
|
71 | 72 | intersphinx_mapping = { |
72 | | - 'python': ('https://docs.python.org/3/', None), |
73 | | - 'sphinx': ('https://www.sphinx-doc.org/en/master/', None), |
| 73 | + "python": ("https://docs.python.org/3/", None), |
| 74 | + "sphinx": ("https://www.sphinx-doc.org/en/master/", None), |
74 | 75 | } |
75 | | -intersphinx_disabled_domains = ['std'] |
| 76 | +intersphinx_disabled_domains = ["std"] |
76 | 77 |
|
77 | | -templates_path = ['_templates'] |
| 78 | +templates_path = ["_templates"] |
78 | 79 |
|
79 | 80 | # -- Options for HTML output |
80 | 81 |
|
|
142 | 143 | } |
143 | 144 | """ |
144 | 145 |
|
145 | | -html_theme = 'furo' |
| 146 | +html_theme = "furo" |
146 | 147 | html_theme_options = { |
147 | | - 'collapse_navigation': False, |
148 | | - 'display_version': True, |
149 | | - 'logo_only': False, |
150 | | - "index": "page.html" |
| 148 | + "collapse_navigation": False, |
| 149 | + "display_version": True, |
| 150 | + "logo_only": False, |
| 151 | + "index": "page.html", |
151 | 152 | } |
152 | 153 |
|
153 | 154 | # adjust code block style for readthedocs |
|
159 | 160 | display_gitlab = False |
160 | 161 | show_source = True |
161 | 162 | # -- Options for EPUB output |
162 | | -epub_show_urls = 'footnote' |
| 163 | +epub_show_urls = "footnote" |
0 commit comments