search

cavalab / brush

An interpretable machine learning library
http://cavalab.org/brush/
GNU General Public License v3.0
2 stars 0 forks source link

docs build commands #7

Closed lacava closed 2 years ago

lacava commented 2 years ago

Hi @JDRomano2

what are the build commands for the docs? if I run

cd docs
sphinx-build . ../_site

I am able to generate a site, but it is mostly blank and has this breathe message in several places:

Warning doxygennamespace: breathe_default_project value ‘brush’ does not seem to be a valid key for the breathe_projects dictionary

lacava commented 2 years ago

oh, is it part of CMake?

JDRomano2 commented 2 years ago

It's all handled by setuptools and CMake. So when you run pip install . it builds the CPP code, the python package, and all of the documentation via sphinx/breathe/doxygen. If another behavior is desired we can change it.