File size: 2,191 Bytes
198fb2a | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 | # OpenROAD-flow-scripts Documentation
This is the source for the OpenROAD-flow-scripts (ORFS) documentation, published
at [https://openroad-flow-scripts.readthedocs.io/en/latest/](https://openroad-flow-scripts.readthedocs.io/en/latest/).
The documentation for the OpenROAD application itself lives in a different
repository and is published at
[https://openroad.readthedocs.io/en/latest/](https://openroad.readthedocs.io/en/latest/).
## Build locally
### Requires
- Python 3.10 — the version Read the Docs builds with (see `.readthedocs.yaml`).
The pinned Sphinx release does not run on Python 3.13 or newer.
- `pip`
- `virtualenv` (or the standard-library `venv`)
### Install prerequisites
Run from the repository root:
``` shell
virtualenv .venv
source .venv/bin/activate
pip install -r docs/requirements_lock.txt
```
`docs/requirements_lock.txt` is the hash-pinned lock file that Read the Docs
installs, so a local build matches the published one. The direct dependencies
are listed in `docs/requirements.in`; after editing that file, regenerate the
lock with:
``` shell
pip-compile --generate-hashes --output-file=docs/requirements_lock.txt docs/requirements.in
```
### Build
``` shell
cd docs
make html
```
The generated site is in `docs/build/html`; open `docs/build/html/index.html`.
### Check for broken links
``` shell
cd docs
make checklinks
```
The report is written to `docs/build/output.txt` (and `docs/build/output.json`).
It exits non-zero when any link is unreachable.
### Notes
- The build needs network access: `docs/conf.py` downloads three files from the
OpenROAD repository at build time.
- Building writes generated pages into the source tree: `index2.md`,
`SupportedOS.md`, `Manpage.md`, `mainREADME.md`, and — because it is fetched
rather than authored here — the tracked file `contrib/GitGuide.md`. Do not
commit those changes; `git checkout docs/contrib/GitGuide.md` after a build.
- Always `rm -rf docs/build` before rebuilding. The output directory is
`build/`, but `conf.py`'s `exclude_patterns` only excludes `_build`, so a
second run picks up the Markdown files written under `build/html/` as if they
were source pages.
|