Mads Marquart
0389b838bc
Merge pull request #455 from carpedm20/add-spell-check
...
Add spell checking.
Use sphinxcontrib-spelling to fix documentation and docstring spelling errors.
2019-07-25 18:51:53 +02:00
Mads Marquart
441f53e382
Merge pull request #454 from carpedm20/google-style-docstrings
...
Google docstring style
2019-07-24 21:56:33 +02:00
Mads Marquart
cc9d81a39e
Fix spelling mistakes in documentation
2019-07-24 16:18:15 +02:00
Mads Marquart
edf14cfd84
Add and configure sphinxcontrib-spelling
2019-07-24 16:17:36 +02:00
Mads Marquart
ee79969eda
Delete docs/robots.txt
...
Introduced in a2930b4
2019-07-24 16:15:31 +02:00
Mads Marquart
5b69ced1e8
Add ability to use Google style docstrings
...
Use and configure the `napoleon` Sphinx extension
2019-07-24 13:43:02 +02:00
Mads Marquart
1b08243cd2
Fix TODO entries showing file paths of the build system
2019-07-24 00:33:55 +02:00
Mads Marquart
a9c681818a
Enable strict/explicit code highlighting
2019-07-03 23:42:32 +02:00
Mads Marquart
d279c96dd5
Make docs parsing "nitpicky"
2019-07-03 23:18:02 +02:00
Mads Marquart
d30589d1fa
Add rst_prolog to docs/conf.py
2019-07-03 17:46:42 +02:00
Mads Marquart
47c744e5e2
Fix reST any roles/references
2019-07-03 17:35:38 +02:00
Mads Marquart
708869ea93
Include missing models in auto-generated API docs
2019-07-03 17:19:11 +02:00
Mads Marquart
a2930b4386
Deprecate the doc url at /en/master/ in favor of /en/latest/
2019-07-03 17:15:21 +02:00
Mads Marquart
2bd08c8254
Update Sphinx to version 2.0
2019-07-03 14:22:09 +02:00
Mads Marquart
81278ed553
Remove doc configuration entries that are set to the default
2019-07-03 14:21:40 +02:00
Mads Marquart
589cec66e1
Refactor doc files to match format generated by sphinx-quickstart
2019-07-03 14:21:25 +02:00
Mads Marquart
53c19f473b
Remove utils.py
...
The file, and contained functions, were explicitly documented as something you couldn't rely on for backwards compatibility
2019-06-23 17:38:27 +02:00
Mads Marquart
929c2137bf
Move model docstrings into the class level, out of init
2019-02-24 20:18:00 +01:00
Mads Marquart
e0710a2ec1
Format strings using black
2019-01-31 20:55:22 +01:00
Mads Marquart
d20fc3b9ce
Format using black (without string normalization)
2019-01-31 20:54:32 +01:00
ekohilas
d180650c1b
spellchecked docs
2018-10-25 18:18:19 +11:00
Mads Marquart
7ecf229db5
See commit description
...
- Deprecated `sendMessage` and `sendEmoji` in favor of `send`
- (Almost) Fully integrated attachment support
- Updated tests
- General cleanup
2017-10-21 17:59:44 +02:00
Mads Marquart
a58791048a
Added attachment and mention support in onMessage
...
Deprecated `message` in `onMessage`
2017-09-21 22:32:11 +02:00
Mads Marquart
1d42c4d3a6
Updated to 1.0.4, added fetchThread&GroupInfo and improved models
2017-06-26 15:41:58 +02:00
Mads Marquart
11e59e023c
Added GraphQL requests
2017-06-22 22:38:15 +02:00
Mads Marquart
c81d7d2bfb
Removed deprecations and new event system, improved other things
...
Removed deprecations
Removed new event system
Added documentation for all events
Added FAQ
Changed Client.uid to Client.id
Improved User model
Prepared for support of pages
2017-06-20 14:57:23 +02:00
Mads Marquart
8dacc37ba9
More documentation work, changed addUsersToGroup back to taking a list of user IDs
...
Created new README, and finished `intro`
2017-05-28 21:11:16 +02:00
Mads Marquart
d2741ca419
Added baseline for sphinx documentation and on2FACode event
...
The docs are still very WIP, but they should be functional. Just
execute `make html` in the docs folder, and you should be able to
navigate to `/docs/_build/html` and view it in your browser
2017-05-26 13:38:54 +02:00
