devs/cproof
1
2
Fork 1
Code Issues 43 Pull Requests 6 Actions Packages Projects 1 Releases Wiki Activity

Improve API documentation; add autotests for it #31

Manually merged
jabber.developer merged 9 commits from build/add-api-docs-gen-tests into master 2025-09-15 14:54:44 +00:00
Conversation 1 Commits 9 Files Changed 7 +2430 -1291
jabber.developer commented 2025-09-10 15:25:30 +00:00
Owner
Copy Link

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.

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.
jabber.developer added 1 commit 2025-09-10 15:25:30 +00:00
ci: add GitHub Actions workflow to test C and Python API doc generation
Some checks failed
CI / Check coding style (pull_request) Successful in 38s
Details
CI / Check spelling (pull_request) Successful in 19s
Details
CI / Test C API Documentation Generation (pull_request) Failing after 27s
Details
CI / Test Python API Documentation Generation (pull_request) Failing after 27s
Details
CI / Linux (arch) (pull_request) Successful in 15m0s
Details
CI / Linux (ubuntu) (pull_request) Successful in 15m8s
Details
CI / Linux (debian) (pull_request) Successful in 15m16s
Details
a21dd9de5b 
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.
jabber.developer commented 2025-09-10 15:26:05 +00:00
Author
Owner
Copy Link

At this point, the jobs are expected to fail, since API contains numerous issues.

At this point, the jobs are expected to fail, since API contains numerous issues.
admin added 1 commit 2025-09-10 16:10:41 +00:00
docs(prof.py): overhaul documentation to align with Google Python Style Guide
Some checks failed
CI / Check spelling (pull_request) Successful in 20s
Details
CI / Test C API Documentation Generation (pull_request) Failing after 26s
Details
CI / Check coding style (pull_request) Successful in 32s
Details
CI / Test Python API Documentation Generation (pull_request) Failing after 24s
Details
CI / Linux (arch) (pull_request) Has been cancelled
Details
CI / Linux (debian) (pull_request) Has been cancelled
Details
CI / Linux (ubuntu) (pull_request) Has been cancelled
Details
692c9513c0 
- 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
jabber.developer changed title from ci: add GitHub Actions workflow to test C and Python API doc generation to Improve API documentation; add autotests for it 2025-09-10 16:11:44 +00:00
admin force-pushed build/add-api-docs-gen-tests from 692c9513c0 to 59b7c31554 2025-09-10 16:13:54 +00:00 Compare
admin force-pushed build/add-api-docs-gen-tests from 59b7c31554 to 399abce836 2025-09-10 16:59:36 +00:00 Compare
admin force-pushed build/add-api-docs-gen-tests from 399abce836 to 052e168e9b 2025-09-10 17:05:40 +00:00 Compare
admin added 1 commit 2025-09-10 17:30:28 +00:00
ci: Update doxygen config file via doxygen -u
Some checks failed
CI / Check spelling (pull_request) Successful in 22s
Details
CI / Test C API Documentation Generation (pull_request) Successful in 28s
Details
CI / Check coding style (pull_request) Successful in 37s
Details
CI / Test Python API Documentation Generation (pull_request) Failing after 28s
Details
CI / Linux (ubuntu) (pull_request) Has been cancelled
Details
CI / Linux (debian) (pull_request) Has been cancelled
Details
CI / Linux (arch) (pull_request) Has been cancelled
Details
a4cead7fe8
admin added 1 commit 2025-09-10 17:32:38 +00:00
ci: Disable Doxygen HTML generation
Some checks failed
CI / Check spelling (pull_request) Successful in 48s
Details
CI / Test C API Documentation Generation (pull_request) Successful in 1m5s
Details
CI / Check coding style (pull_request) Successful in 1m35s
Details
CI / Test Python API Documentation Generation (pull_request) Failing after 1m17s
Details
CI / Linux (debian) (pull_request) Has been cancelled
Details
CI / Linux (ubuntu) (pull_request) Has been cancelled
Details
CI / Linux (arch) (pull_request) Has been cancelled
Details
3ffeda1531 
Since only XML is being used during website build process, generation of HTML involves unnecessary computations.
admin added 1 commit 2025-09-10 17:35:25 +00:00
docs: fix C API documentation
Some checks failed
CI / Check spelling (pull_request) Successful in 45s
Details
CI / Test C API Documentation Generation (pull_request) Successful in 1m20s
Details
CI / Check coding style (pull_request) Successful in 1m29s
Details
CI / Test Python API Documentation Generation (pull_request) Failing after 1m24s
Details
CI / Linux (ubuntu) (pull_request) Has been cancelled
Details
CI / Linux (debian) (pull_request) Has been cancelled
Details
CI / Linux (arch) (pull_request) Has been cancelled
Details
e998d5e7ef 
`barejid` parameter was used instead of the intended `roomjid`, leading to warnings during compilation.
admin added 1 commit 2025-09-10 17:38:29 +00:00
ci(Doxygen): Enable warning as error
Some checks failed
CI / Check spelling (pull_request) Successful in 25s
Details
CI / Test C API Documentation Generation (pull_request) Successful in 1m21s
Details
CI / Check coding style (pull_request) Successful in 1m59s
Details
CI / Test Python API Documentation Generation (pull_request) Failing after 1m30s
Details
CI / Linux (debian) (pull_request) Successful in 13m58s
Details
CI / Linux (ubuntu) (pull_request) Successful in 14m18s
Details
CI / Linux (arch) (pull_request) Successful in 19m30s
Details
7e4c60e2c3 
To ensure that CI builds fails to reflect issues within the documentations
admin added 2 commits 2025-09-15 12:33:43 +00:00
docs(plugin): update plugin.py to align with formatting required by Sphinx 4cdcf9a8eb 
- Replace Profanity with CProof in all docstrings and examples.
- Remove Python 2 and unicode references, using Python 3 str types.
- Add type hints for all parameters and return types.
- Use :: for code blocks with blank lines to fix Sphinx errors.
- Improve wording for clarity and integrated examples into docstrings.
- Organize functions into logical sections with RST comments.
- Use double backticks for inline literals to resolve Sphinx warnings.
docs(prof.py): add CommandCallback, TimedCallback, WindowCallback protocols
Some checks failed
CI / Check spelling (pull_request) Successful in 19s
Details
CI / Test C API Documentation Generation (pull_request) Successful in 23s
Details
CI / Check coding style (pull_request) Successful in 35s
Details
CI / Test Python API Documentation Generation (pull_request) Failing after 26s
Details
CI / Linux (arch) (pull_request) Has been cancelled
Details
CI / Linux (debian) (pull_request) Has been cancelled
Details
CI / Linux (ubuntu) (pull_request) Has been cancelled
Details
a421ef8473 
- Defined callback protocols for register_command, register_timed, win_create.
- Fixed Sphinx callable warnings with proper type hints.
admin force-pushed build/add-api-docs-gen-tests from a421ef8473 to aa0522acf8 2025-09-15 12:38:35 +00:00 Compare
admin force-pushed build/add-api-docs-gen-tests from aa0522acf8 to cb6f302208 2025-09-15 13:48:02 +00:00 Compare
admin added 1 commit 2025-09-15 13:55:56 +00:00
docs(sphinx): fix conf.py and index.rst to resolve warnings
Some checks failed
CI / Check spelling (pull_request) Successful in 51s
Details
CI / Test C API Documentation Generation (pull_request) Successful in 52s
Details
CI / Check coding style (pull_request) Successful in 1m22s
Details
CI / Test Python API Documentation Generation (pull_request) Failing after 1m1s
Details
CI / Linux (debian) (pull_request) Successful in 12m49s
Details
CI / Linux (ubuntu) (pull_request) Successful in 13m12s
Details
CI / Linux (arch) (pull_request) Successful in 16m22s
Details
2dc99ca745 
- Removed unnecessary list item (*) from :ref:`genindex`.
- Added blank line after :ref:`genindex` to terminate markup block.
- Rebranded configs
admin force-pushed build/add-api-docs-gen-tests from 2dc99ca745 to 105c496ab1 2025-09-15 14:12:55 +00:00 Compare
jabber.developer manually merged commit 353b6bdb11 into master 2025-09-15 14:54:44 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
Compat/Breaking
Breaking change that won't be backward compatible
Kind/Bug
Something is not working
Kind/Documentation
Documentation changes
Kind/Enhancement
Improve existing functionality
Kind/Feature
New functionality
Kind/Security
This is security issue
Kind/Testing
Issue or pull request related to testing
Priority
Critical
1
The priority is critical
Priority
High
2
The priority is high
Priority
Low
4
The priority is low
Priority
Medium
3
The priority is medium
Reviewed
Confirmed
1
Issue has been confirmed
Reviewed
Duplicate
2
This issue or pull request already exists
Reviewed
Invalid
3
Invalid issue
Reviewed
Won't Fix
3
This issue won't be fixed
Status
Abandoned
3
Somebody has started to work on this but abandoned work
Status
Blocked
1
Something is blocking this issue or pull request
Status
Need More Info
2
Feedback is required to reproduce issue or to continue work
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
admin jabber.developer jabber.developer2
No Assignees
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: devs/cproof#31
No description provided.
Delete Branch "build/add-api-docs-gen-tests"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?