Skip to content

Instantly share code, notes, and snippets.

@vibhatha

vibhatha/sphinx-with-doxygen-setup.md

Created November 29, 2022 03:33
Show Gist options
  • Save vibhatha/365f0ba05b24db0766547e63de1b1861 to your computer and use it in GitHub Desktop.
Save vibhatha/365f0ba05b24db0766547e63de1b1861 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
sphinx-with-doxygen-setup.md

Building Documentation

Install pre-requisites

Within the same conda environment created to build pyvelox install the following conda packages

conda install -c conda-forge pandoc
conda install -c anaconda sphinx
conda install -c conda-forge doxygen

Building Doxygen documentation

pushd docs/doxygen
doxygen
popd

Building Sphinx documentation

pushd docs
pandoc ../pyvelox/README.md --from markdown --to rst -s -o sphinx/source/README_generated_pyvelox.rst
pandoc README.md --from markdown --to rst -s -o sphinx/source/README_generated_docs.rst
pushd sphinx
sphinx-build source _build/html
make html

Generated html files are at docs/sphinx/_build.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment