File tree Expand file tree Collapse file tree 3 files changed +14
-57
lines changed
Expand file tree Collapse file tree 3 files changed +14
-57
lines changed Original file line number Diff line number Diff line change 11# .readthedocs.yaml
2+ # ReadTheDocs configuration for SerDes Validation Framework
23version : 2
34
45build :
56 os : ubuntu-22.04
67 tools :
78 python : " 3.10"
89 jobs :
9- pre_create_environment :
10- # Set up mock mode for documentation builds
11- - echo "SVF_MOCK_MODE=1" >> $READTHEDOCS_VIRTUALENV_PATH/bin/activate
1210 post_install :
13- # Ensure mock mode is available during doc generation
1411 - export SVF_MOCK_MODE=1
1512
1613sphinx :
1714 configuration : docs/conf.py
18- fail_on_warning : false # Allow warnings for mock imports
19- builder : html
15+ fail_on_warning : false
2016
2117python :
2218 install :
2319 - method : pip
2420 path : .
2521 extra_requirements :
2622 - docs
27- - dev # Include development dependencies for mock support
2823 - requirements : docs/requirements.txt
2924
30- # Build formats
3125formats :
32- - pdf
33- - epub
34- - htmlzip
35-
36- # Search configuration
37- search :
38- ranking :
39- api/* : 2
40- tutorials/* : 3
41- guides/* : 1
42- examples/* : 1
43-
44- # Subprojects for versioning
45- subprojects :
46- include :
47- - usb4-api
48- - mock-testing
49- - reporting-system
26+ - htmlzip
Original file line number Diff line number Diff line change 3333
3434extensions = [
3535 'sphinx.ext.autodoc' ,
36- 'sphinx.ext.autosummary' ,
3736 'sphinx.ext.viewcode' ,
3837 'sphinx.ext.napoleon' ,
3938 'sphinx.ext.intersphinx' ,
40- 'sphinx.ext.todo' ,
41- 'sphinx.ext.coverage' ,
42- 'sphinx.ext.mathjax' ,
43- 'sphinx.ext.ifconfig' ,
44- 'sphinx.ext.githubpages' ,
39+ 'myst_parser' ,
40+ 'sphinx_copybutton' ,
4541 'sphinxcontrib.mermaid' ,
46- 'myst_parser' , # For Markdown support
47- 'sphinx_rtd_theme' ,
48- 'sphinx.ext.graphviz' ,
49- 'sphinx_copybutton' , # Copy button for code blocks
5042]
5143
5244# Add any paths that contain templates here, relative to this directory.
Original file line number Diff line number Diff line change 1- # Documentation build requirements
1+ # Documentation build requirements for ReadTheDocs
22
3- # Sphinx and extensions
4- sphinx >= 5 .0.0
5- sphinx-rtd-theme >= 1.2 .0
6- myst-parser >= 0.18.0
3+ # Core Sphinx
4+ sphinx >= 4.0.0 , < 7 .0.0
5+ sphinx-rtd-theme >= 1.0 .0
6+ myst-parser >= 0.18.1
77sphinx-copybutton >= 0.5.0
8- sphinx-autobuild >= 2021.3.14
98
10- # Additional Sphinx extensions
9+ # Sphinx extensions
1110sphinxcontrib-mermaid >= 0.7.1
12- sphinxcontrib-plantuml >= 0.24
13- sphinx-tabs >= 3.4.0
1411sphinx-design >= 0.3.0
1512
16- # Documentation utilities
17- doc8 >= 0.11.0
18- rstcheck >= 6.0.0
19-
20- # Framework dependencies (for autodoc)
13+ # Framework dependencies (minimal for autodoc)
2114numpy >= 1.21.0
2215scipy >= 1.7.0
2316pandas >= 1.3.0
2417matplotlib >= 3.5.0
25- pyyaml >= 6.0
26- click >= 8.0
27- tqdm >= 4.62.0
28- structlog >= 21.1.0
2918
30- # Mock dependencies for documentation builds
31- mock >= 4.0.0
32- pytest >= 7.0.0
19+ # Mock support for documentation builds
20+ mock >= 4.0.0
You can’t perform that action at this time.
0 commit comments