From 48d37cf12a764b0c835574c23e6d429a90afc31f Mon Sep 17 00:00:00 2001 From: Daniel Schadt Date: Tue, 29 Jul 2025 22:48:25 +0200 Subject: add documentation for hittekaart_py This is not 100% fietsboek, but it's closely related, and I don't think setting up a separate site for hittekaart is worth it. At the moment, this is a bit WIP, as the module sits in its own branch in the hittekaart repository, but in the long run I want to use this. It also is an experiment to see how well PyO3 works, as we potentially want to migrate other parts of fietsboek to Rust in the future (no specifics yet, but keeping the option available is nice). In tox.ini, we disable -f for sphinx-apidoc, so that it doesn't overwrite the modules.rst file. This means that the directory must be clean if you re-generate the docs (it is on the CI server). Also, we un-gitignore the modules.rst and hittekaart_py.rst files, as special cases. The others are still auto-generated, so all good, but these two we need. --- .gitignore | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to '.gitignore') diff --git a/.gitignore b/.gitignore index 56f6db9..99e9602 100644 --- a/.gitignore +++ b/.gitignore @@ -26,5 +26,8 @@ test poetry.toml /language-packs # The module docs are regenerated using sphinx-apidoc -doc/developer/module/ +doc/developer/module/* +# However, we manually document hittekaart_py: +!doc/developer/module/modules.rst +!doc/developer/module/hittekaart_py.rst /node_modules -- cgit v1.2.3