File size: 1,400 Bytes
d59bb1b |
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 |
# OpenROAD Documentation
This `docs/` hierarchy houses code and raw files to
build the on-line documentation (using Sphinx) and
manual pages using (using Pandoc)
This on-line documentation is available at [https://openroad.readthedocs.io/en/latest/](https://openroad.readthedocs.io/en/latest/).
## Prerequisites
- To install pandoc, refer to this [link](https://github.com/jgm/pandoc/blob/main/INSTALL.md). `apt-get` *should* just work for Ubuntu.
- To install sphinx requirements, **create a virtual environment (e.g. conda/virtualenv)** and then run `pip install -r requirements.txt`.
### Build instructions for Pandoc manpages
The `-j16` command is optional for speeding up the manpage compilation process by using multiple jobs
based on the number of cores in your system.
```shell
make clean
# Note this step is important as it regenerates the documentation using latest sources.
make preprocess && make all -j16
```
#### To view manpages
- To run `man` commands inside OpenROAD, you can either use the Linux `man` binary:
```tcl
# create a man wrapper
source man/scripts/main.tcl
man openroad
```
- Or just within OpenROAD itself.
```tcl
# you will be prompted to enter the RELATIVE path to cat folders which is optional.
man openroad
```
### Build instructions for Sphinx docs
#### HTML docs
``` shell
make html
```
#### Check for broken links
``` shell
make checklinks
```
|