Skip to content

Commit 67057f0

Browse files
committed
[no ci] docs: how to add new top-level modules to the docs
1 parent 23328af commit 67057f0

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,7 @@ pip install .[docs]
145145
```
146146

147147
The overall *structure* of the documentation is manually designed, but the API documentation is auto-generated.
148+
New top-level modules (i.e., `bayesflow.mynewmodule`) have to be manually added to the list in `docsrc/source/api/bayesflow.rst` to be included.
148149

149150
You can re-build the current documentation with
150151

0 commit comments

Comments
 (0)