Skip to content

Commit c91ba55

Browse files
gastmaierladace
authored andcommitted
docs: Use doctools (#1258)
The extensions have been moved to docs tools. The source code is available at https://github.com/analogdevicesinc/doctools And is installed as before: (cd docs ; pip install -r requirements.txt --upgrade) Since the package is listed on the requirements.txt file. Also, add index for library and projects Signed-off-by: Jorge Marques <[email protected]>
1 parent 3b272fa commit c91ba55

File tree

15 files changed

+115
-2293
lines changed

15 files changed

+115
-2293
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,13 @@ This repository supports reference designs for different [Analog Devices boards]
4747

4848
### Building documentation
4949

50+
Ensure pip is newer than version 23.
51+
```
52+
pip install pip --upgrade
53+
```
5054
Install the documentation tools.
5155
```
52-
(cd docs ; pip install -r requirements.txt)
56+
(cd docs ; pip install -r requirements.txt --upgrade)
5357
```
5458
Build the libraries (recommended).
5559
```

docs/conf.py

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
1-
# Configuration file for the Sphinx documentation builder.
2-
#
3-
# https://www.sphinx-doc.org/en/master/usage/configuration.html
1+
# -- Project information ------------------------------------------------------
42

5-
# -- Project information -----------------------------------------------------
3+
repository = 'hdl'
4+
project = 'HDL'
5+
copyright = '2024, Analog Devices, Inc.'
6+
author = 'Analog Devices, Inc.'
67

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 ----------------------------------------------------
179

1810
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"
2415
]
2516

26-
templates_path = ['sources/template']
17+
needs_extensions = {
18+
'adi_doctools': '0.3'
19+
}
2720

2821
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
22+
source_suffix = '.rst'
2923

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 ------------------------------------------
3131

3232
hide_collapsible_content = True
3333
validate_links = False
@@ -39,8 +39,7 @@
3939

4040
# -- Options for HTML output --------------------------------------------------
4141

42-
html_theme = 'furo'
42+
html_theme = 'cosmic'
4343
html_static_path = ['sources']
44-
source_suffix = '.rst'
4544
html_css_files = ["custom.css"]
4645
html_favicon = "sources/icon.svg"

0 commit comments

Comments
 (0)