Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
version: 2

formats:
- pdf
- epub

build:
os: ubuntu-24.04
tools:
Expand All @@ -8,9 +12,15 @@ build:
jobs:
build:
html:
- python -m pip install -r docs/requirements.txt
- cd docs && npm ci
- cd docs && python scripts/sphinx_to_starlight.py
- cd docs && npm run build:astro
- mkdir -p $READTHEDOCS_OUTPUT/html
- cp -r docs/dist/* $READTHEDOCS_OUTPUT/html/

sphinx:
configuration: docs/conf.py

python:
install:
- requirements: docs/requirements.txt
6 changes: 6 additions & 0 deletions conda-reqs/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,9 @@ dependencies:
- sphinx-autobuild
- sphinx_rtd_theme
- docutils
- requests

# Install Node.js outside conda to avoid conflicting with the ICU version
# required by Chipyard's toolchain. fnm reads docs/.nvmrc and installs an
# official Node.js binary that does not use conda's ICU package.
- fnm
1 change: 1 addition & 0 deletions docs/.nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
22
9 changes: 7 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,10 @@ Node dependencies:

```sh
source env.sh
python -m pip install -r docs/requirements.txt
cd docs
eval "$(fnm env --shell bash)"
fnm install --use
npm ci
npm run dev
```
Expand All @@ -25,8 +28,10 @@ The active environment must include the Python/Sphinx dependencies from either
`requirements.txt` or `../conda-reqs/docs.yaml`, because the Starlight build
starts by rendering the RST source with Sphinx. Read the Docs installs
`requirements.txt` with pip to avoid a slow conda solve, while local development
can use the docs conda environment. Node.js is provided separately by Read the
Docs via `.readthedocs.yml`, or by any local Node installation on `PATH`.
can use the docs conda environment. That environment provides `fnm`, which
installs the Node.js version selected by `.nvmrc` outside conda to avoid a
toolchain ICU conflict. Read the Docs provides Node.js separately through
`.readthedocs.yml`.

Build static docs:

Expand Down
37 changes: 19 additions & 18 deletions docs/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
},
"dependencies": {
"@astrojs/starlight": "0.41.3",
"astro": "7.0.7"
"astro": "^7.1.3"
},
"devDependencies": {
"chokidar": "5.0.0"
Expand Down
2 changes: 1 addition & 1 deletion sims/firesim
Submodule firesim updated 1 files
+45 −51 build-setup-nolog.sh
Loading