docs(prof.py): overhaul documentation to align with Google Python Style Guide

- Updated project references from Profanity to CProof. - Removed Python 2 and unicode references. - Added type hints for all parameters and return types. - Organized functions into logical sections with RST comments for Sphinx. - Improved wording for clarity and precision based on source code analysis. - Ensured compliance with Google Python Style Guide for readable docstrings. Related to #30
ci: add GitHub Actions workflow to test C and Python API doc generation
2025-09-10 19:05:33 +02:00 · 2025-09-10 19:05:32 +02:00
1 changed files with 1 additions and 1 deletions
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -117,4 +117,4 @@ jobs:
      - name: Test Python API docs generation
        run: |
          cd apidocs/python/
-          sphinx-apidoc -f -o . src && make -j$(nproc) xml
+          sphinx-apidoc -f -o . src && make -j$(nproc) xml SPHINXOPTS="-W --keep-going -n"
Author	SHA1	Message	Date
Jabber Developer	052e168e9b	docs(prof.py): overhaul documentation to align with Google Python Style Guide Some checks failed CI / Check spelling (pull_request) Successful in 39s Details CI / Test C API Documentation Generation (pull_request) Successful in 52s Details CI / Check coding style (pull_request) Successful in 1m26s Details CI / Test Python API Documentation Generation (pull_request) Failing after 1m7s Details CI / Linux (ubuntu) (pull_request) Successful in 13m21s Details CI / Linux (debian) (pull_request) Successful in 15m48s Details CI / Linux (arch) (pull_request) Successful in 20m26s Details - Updated project references from Profanity to CProof. - Removed Python 2 and unicode references. - Added type hints for all parameters and return types. - Organized functions into logical sections with RST comments for Sphinx. - Improved wording for clarity and precision based on source code analysis. - Ensured compliance with Google Python Style Guide for readable docstrings. Related to #30	2025-09-10 19:05:33 +02:00
Jabber Developer	c94cd0b549	ci: add GitHub Actions workflow to test C and Python API doc generation Introduce separate jobs to test C (Doxygen) and Python (Sphinx) API documentation generation. Ensures build failures are caught early, as API changes often produce warnings that developers miss without automated checks.	2025-09-10 19:05:32 +02:00