building the documentation

Jump to bottom

cardano-node-wiki edited this page Aug 4, 2023 · 1 revision

Building the documentation

Pre-requisites

brew install sphinx-doc

Ensure any post install steps are executed.

sphinx-build -b html . builddir
pip3 install sphinx-rtd-theme
pip3 install recommonmark
pip3 install sphinx_markdown_tables --user
pip3 install sphinxemoji --user

Building documentation

sphinx-build doc html

Open the documentation at html/index.html

The cardano-node wiki has moved. Please go to (https://github.com/input-output-hk/cardano-node-wiki/wiki) and look for the page there.