Skip to content

Latest commit

 

History

History
 
 

sphinx

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

sphinx API reference

This file describes the sphinx setup for auto-generating the botorch API reference.

Installation

Requirements:

  • sphinx >= 3.0 (Install via pip install sphinx)

Building

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

Structure

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.