This file describes the sphinx setup for auto-generating the botorch API reference.
Requirements:
- sphinx >= 3.0 (Install via
pip install sphinx
)
From the botorch/sphinx
directory, run make html
.
Generated HTML output can be found in the botorch/sphinx/build
directory. The main index page is: botorch/sphinx/build/html/index.html
source/index.rst
contains the main index. The API reference for each module lives in its own file, e.g. models.rst
for the botorch.models
module.