Mads Marquart
66fdd91953
Disable fixup_module_metadata when running Sphinx
2020-01-22 19:21:10 +01:00
Mads Marquart
41f367a61b
Use sphinx-autodoc-typehints
2020-01-22 03:29:26 +01:00
Mads Marquart
b6fd7e2cf2
Remove unnecessary dunder package attributes
2020-01-22 02:41:39 +01:00
Mads Marquart
66505f8f41
Remove redundant encoding specifiers and __future__ imports
2019-08-28 21:57:46 +02:00
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
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
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
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
