Following packages should be installed in the system or into the local virtualenv environement:

pip install --upgrade pip
pip install -U --pre sphinx
pip install myst_parser
pip install pygments-markdown-lexer

Note: Documentation site uses ReadTheDocs theme that is installed inside the documentation source tree.

Bloomberg development machines have pre-configured sphinx environment with all necessary modules. To load the environment:

source /bb/bde/documentation/sphinx_env/bin/activate

The documentation site is generated by the provided Makefile by running folowing command:

make internal

The generated site can be found in the build/internal/html folder.

Developers in a Bloomberg environment can make a symbolic link to their public_html directory using:

ln -s $PWD/build/internal/html ~/public_html/bde-tools

The documentation site is generated by the provided Makefile by running folowing command:

make oss

The generated site can be found in the build/oss/html folder. The site can be served with any web server of your choice.