92cb930810
docs: Fix indentation
CI API Docs / Test C API Documentation Generation (pull_request) Successful in 26s
CI API Docs / Test Python API Documentation Generation (pull_request) Successful in 28s
CI Code / Check coding style (pull_request) Successful in 35s
CI Code / Check spelling (pull_request) Successful in 18s
CI Code / Linux (debian) (pull_request) Successful in 13m38s
CI Code / Linux (ubuntu) (pull_request) Successful in 16m18s
CI Code / Linux (arch) (pull_request) Successful in 16m46s
2025-09-17 01:37:10 +02:00
c94263486f
docs(python): fix formatting to ensure correct parsing
...
Fixes issues introduced in 052e1684cdcf9a#31 .
2025-09-17 00:34:37 +02:00
105c496ab1
docs(sphinx): fix conf.py and index.rst to resolve warnings
...
CI / Check spelling (pull_request) Successful in 19s
CI / Test C API Documentation Generation (pull_request) Successful in 23s
CI / Check coding style (pull_request) Successful in 31s
CI / Test Python API Documentation Generation (pull_request) Successful in 29s
CI / Linux (debian) (pull_request) Successful in 13m34s
CI / Linux (ubuntu) (pull_request) Successful in 14m4s
CI / Linux (arch) (pull_request) Successful in 17m4s
- Removed unnecessary list item (*) from :ref:`genindex`.
- Added blank line after :ref:`genindex` to terminate markup block.
- Rebranded configs
2025-09-15 16:12:47 +02:00
cb6f302208
docs(prof.py): add CommandCallback, TimedCallback, WindowCallback protocols
...
CI / Check spelling (pull_request) Successful in 22s
CI / Test C API Documentation Generation (pull_request) Successful in 26s
CI / Check coding style (pull_request) Successful in 36s
CI / Test Python API Documentation Generation (pull_request) Failing after 28s
CI / Linux (debian) (pull_request) Has been cancelled
CI / Linux (arch) (pull_request) Has been cancelled
CI / Linux (ubuntu) (pull_request) Has been cancelled
- Defined callback protocols for register_command, register_timed, win_create.
- Fixed Sphinx callable warnings with proper type hints.
- Align docs with the code
2025-09-15 15:47:10 +02:00
4cdcf9a8eb
docs(plugin): update plugin.py to align with formatting required by Sphinx
...
- 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.
2025-09-15 11:53:49 +02:00
052e168e9b
docs(prof.py): overhaul documentation to align with Google Python Style Guide
...
CI / Check spelling (pull_request) Successful in 39s
CI / Test C API Documentation Generation (pull_request) Successful in 52s
CI / Check coding style (pull_request) Successful in 1m26s
CI / Test Python API Documentation Generation (pull_request) Failing after 1m7s
CI / Linux (ubuntu) (pull_request) Successful in 13m21s
CI / Linux (debian) (pull_request) Successful in 15m48s
CI / Linux (arch) (pull_request) Successful in 20m26s
- 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
7fcc14fdea
build: change docs configuration to build XML
...
CI / Check spelling (push) Successful in 17s
CI / Check coding style (push) Successful in 33s
CI / Linux (debian) (push) Successful in 9m54s
CI / Linux (ubuntu) (push) Successful in 12m4s
CI / Linux (fedora) (push) Successful in 13m45s
CI / Linux (arch) (push) Successful in 15m20s
So it can be used as a part of CI for the website
2025-07-08 01:52:56 +02:00
Michael Vetter
d64e797665
Fix typos in apidocs
2021-10-01 23:06:29 +02:00
a1346054
a1dc3d1237
Trim excess whitespace
2021-08-26 01:18:10 +00:00
raspbeguy
c0fe3cf155
Fix typos in functions names
...
Probably a refactoring that didn't go well.
2021-07-12 16:43:48 +02:00
Dustin Lagoy
2b56e33d16
Fix prof_get_name_from_roster documentation
2021-04-29 14:03:17 -04:00
Dustin Lagoy
2350a94c44
Add plugin get_barejid_from_roster function
2021-04-29 13:50:57 -04:00
Dustin Lagoy
802442fffc
Change nick to name in api to match convention
...
Change all instances of *get_nick_from_roster to *get_name_from_roster
to match the convention of names in the roster itself.
2021-04-28 09:32:20 -04:00
Dustin Lagoy
ed4d2fcfb2
Add plugin prof_get_nick_from_roster function
2021-04-28 09:17:02 -04:00
James Booth
250e972b7a
Update copyright
2018-01-21 15:00:02 +00:00
James Booth
68a3daedb9
Update Copyright
2017-01-28 17:24:22 +00:00
James Booth
83385cdbc0
Add pre chat and room message blocking
2017-01-22 18:09:04 +00:00
James Booth
7090f85d85
Add chat and room show calls to plugins api
2017-01-21 20:23:28 +00:00
James Booth
9cfd17821c
Allow room display properies to be set by plugins
2017-01-20 23:26:14 +00:00
James Booth
c8874cd2e0
Allow chat prefix char to be set by plugins
2017-01-20 21:03:55 +00:00
James Booth
1b25aa84cb
Add titlebar encryption text to plugins api
2017-01-19 22:33:29 +00:00
James Booth
fccf56be10
Add prof.encryption_reset to Plugins API
...
issue #885
2017-01-18 22:46:29 +00:00
James Booth
dcc2123ec4
Allow filepath autocompletion in plugins
...
closes #858
2016-10-10 22:28:23 +01:00
James Booth
5d6b2d0b04
Add resource to chat message plugin hooks
2016-08-10 21:37:22 +01:00
James Booth
a948d741d9
Rename plugin jid arguments
2016-08-10 20:45:14 +01:00
James Booth
b64a9c3d6d
Fix type in python API docs
2016-08-08 22:01:04 +01:00
James Booth
4f7af4e429
Update plugin API docs
2016-08-07 00:22:21 +01:00
James Booth
7bc160c24e
Update plugin API docs
2016-08-02 23:17:28 +01:00
James Booth
7314a13248
Update gitignore, added python API docs Makefile
2016-08-02 22:54:34 +01:00
James Booth
30e96b2d0f
Fixes to plugin API docs
2016-07-30 23:23:20 +01:00
James Booth
49a213b382
Update python API docs
2016-07-30 23:16:57 +01:00
James Booth
43b1d7f7cd
Update plugins API docs
2016-07-30 23:00:45 +01:00
James Booth
9603e04e34
Update plugin API docs
2016-07-30 22:17:42 +01:00
James Booth
ee79de61f3
Update python API docs
2016-07-30 19:18:37 +01:00
James Booth
c8d231fc75
Update python API docs
2016-07-30 19:06:21 +01:00
James Booth
56afe214d4
Fix type in python api docs
2016-07-30 01:26:27 +01:00
James Booth
645a233aa0
Update python API docs
2016-07-30 01:08:39 +01:00
James Booth
7dd754d344
Updates to python docs
2016-07-29 01:01:54 +01:00
James Booth
a308f5e4f1
Add python plugin hook docs
2016-07-29 00:27:26 +01:00
James Booth
c8f53a64fe
Add Python API docs
2016-07-29 00:10:00 +01:00
