From a0714288d81fc99013fe8f86391464ba2dea82aa Mon Sep 17 00:00:00 2001 From: Florian Spreckelsen <f.spreckelsen@indiscale.com> Date: Fri, 23 Aug 2024 09:20:57 +0200 Subject: [PATCH] DOC: Extend explanation on how to build the documentation --- src/doc/README_SETUP.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/doc/README_SETUP.md b/src/doc/README_SETUP.md index a7519378..32f0bb89 100644 --- a/src/doc/README_SETUP.md +++ b/src/doc/README_SETUP.md @@ -13,7 +13,10 @@ see INSTALL.md We use sphinx to create the documentation. Docstrings in the code should comply with the Googly style (see link below). -Build documentation in `src/doc` with `make html`. +Build documentation in `src/doc` with `make doc`. Note that for the +automatic generation of the complete API documentation, it is +necessary to first install this library with all its optional +dependencies, i.e., `pip install .[h5-crawler,spss]`. ### Requirements ### -- GitLab