Documentation

PBench website gh-pages PBench readthedocs self hosted and readthedoc instance

This dir has all the pbench documentation(api, user guide, commands, gh-pages, etc). Pbench website is hosted on gh-pages and readthedocs pages(/docs) are also hosted along with it.

Readthedocs setup

$ pip3 install -r requirements.txt
$ make clean
$ make html

Note: Above command will build your static readthedocs page/website in _build/html dir.

Some important links

• online markdown editor
• myst-parser is a plugin used to build our markdown documentation.