do not include sphinx-apidoc generated files in git, hide private functions in API docs, add docs/apidoc to gitignore

Author: Zeitsperre

.gitignore

@@ -65,6 +65,8 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/apidoc/modules.rst
+docs/apidoc/xncml*.rst
 
 # PyBuilder
 target/

.readthedocs.yml

@@ -10,6 +10,9 @@ build:
   os: "ubuntu-24.04"
   tools:
     python: 'mambaforge-23.11'
+  jobs:
+    pre_build:
+      - sphinx-apidoc -o docs/apidoc/ --module-first src/xncml
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:

Makefile

@@ -80,7 +80,7 @@ initialize-translations: clean-docs ## initialize translations, ignoring autodoc
 	sphinx-intl update -p docs/_build/gettext -d docs/locales -l fr
 
 autodoc: clean-docs ## create sphinx-apidoc files:
-	sphinx-apidoc -o docs/apidoc --private --module-first src/xncml
+	sphinx-apidoc -o docs/apidoc --module-first src/xncml
 
 linkcheck: autodoc ## run checks over all external links found throughout the documentation
 	$(MAKE) -C docs linkcheck

docs/apidoc/modules.rst

@@ -1,4 +1,4 @@
-Xncml Documentation
+xncml Documentation
 ===================
 
 .. toctree::