|
1 |
| -# Configuration file for the Sphinx documentation builder. |
2 |
| -# |
3 |
| -# https://www.sphinx-doc.org/en/master/usage/configuration.html |
| 1 | +# -- Project information ------------------------------------------------------ |
4 | 2 |
|
5 |
| -# -- Project information ----------------------------------------------------- |
| 3 | +repository = 'hdl' |
| 4 | +project = 'HDL' |
| 5 | +copyright = '2024, Analog Devices, Inc.' |
| 6 | +author = 'Analog Devices, Inc.' |
6 | 7 |
|
7 |
| -project = 'HDL, Analog Devices' |
8 |
| -copyright = '2023, Analog Devices Inc' |
9 |
| -author = 'Analog Devices Inc' |
10 |
| -release = 'v0.1' |
11 |
| - |
12 |
| -# -- General configuration --------------------------------------------------- |
13 |
| - |
14 |
| -import os, sys |
15 |
| - |
16 |
| -sys.path.append(os.path.abspath("./extensions")) |
| 8 | +# -- General configuration ---------------------------------------------------- |
17 | 9 |
|
18 | 10 | extensions = [
|
19 |
| - "sphinx.ext.todo", |
20 |
| - "sphinx.ext.viewcode", |
21 |
| - "sphinxcontrib.wavedrom", |
22 |
| - "adi_links", |
23 |
| - "adi_hdl_parser" |
| 11 | + "sphinx.ext.todo", |
| 12 | + "sphinx.ext.intersphinx", |
| 13 | + "sphinxcontrib.wavedrom", |
| 14 | + "adi_doctools" |
24 | 15 | ]
|
25 | 16 |
|
26 |
| -templates_path = ['sources/template'] |
| 17 | +needs_extensions = { |
| 18 | + 'adi_doctools': '0.3' |
| 19 | +} |
27 | 20 |
|
28 | 21 | exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
| 22 | +source_suffix = '.rst' |
29 | 23 |
|
30 |
| -# -- Custom extensions configuration ------------------------------------------- |
| 24 | +# -- External docs configuration ---------------------------------------------- |
| 25 | + |
| 26 | +intersphinx_mapping = { |
| 27 | + 'doctools': ('https://analogdevicesinc.github.io/doctools', None) |
| 28 | +} |
| 29 | + |
| 30 | +# -- Custom extensions configuration ------------------------------------------ |
31 | 31 |
|
32 | 32 | hide_collapsible_content = True
|
33 | 33 | validate_links = False
|
|
39 | 39 |
|
40 | 40 | # -- Options for HTML output --------------------------------------------------
|
41 | 41 |
|
42 |
| -html_theme = 'furo' |
| 42 | +html_theme = 'cosmic' |
43 | 43 | html_static_path = ['sources']
|
44 |
| -source_suffix = '.rst' |
45 | 44 | html_css_files = ["custom.css"]
|
46 | 45 | html_favicon = "sources/icon.svg"
|
0 commit comments