The documentation is available at: sbi-dev.github.io/sbi
We use mike
to manage, build, and deploy our
documentation with mkdocs
. To build the documentation
locally, follow these steps:
-
Install the documentation dependencies:
python -m pip install .[doc]
-
Convert the current version of the documentation notebooks to markdown and build the website locally using
mkdocs
:jupyter nbconvert --to markdown ../tutorials/*.ipynb --output-dir docs/tutorials/ mkdocs serve
Website deployment is managed with mike
and happens automatically:
- With every push to
main
, adev
version of the most recent documentation is built. - With every new published release, the current documentation is deployed on the website.
Thus, the documentation on the website always refers to the latest release, and not
necessarily to the version on main
.
We welcome contributions to our list of frequently asked questions. To contribute:
- Create a new markdown file named
question_XX.md
in thedocs/faq
folder, whereXX
is a running index for the questions. - The file should start with the question as the title (i.e. starting with a
#
) and then have the answer below. - Add a link to your question in the [
docs/faq.md
] file using the same index.