Ashley Whetter
92437c9af7
Removed old pylint pragmas
1 year ago
Ashley Whetter
94b255aecc
Added support for Python 3.11
2 years ago
Ash Berlin-Taylor
d732b49fd5
Don't force member sort order to alphabetic ( #362 )
...
* Don't force member sort order to alphabetic
sphinx.ext.autodoc has a `sort_member` function[1] that will sort the object
members for us -- by removing the `sorted` call ourselves we allow the
"bysource" mode to work (with the `sorted` call, since we don't set
`self.analyzer` no extra sorting happens.)
The default sort mode for autodoc is alphabetical, so this should result in no
changes to docs by default
[1]: 9844162473/sphinx/ext/autodoc/__init__.py (L816-L836)
2 years ago
Ashley Whetter
a23e2ffe73
Render Python properties with the property directive
...
Fixes #352 .
2 years ago
Ashley Whetter
685d1d34c8
Updated to latest black formatting
3 years ago
Ashley Whetter
826bb2badd
Converted tests to pytest style
4 years ago
Ashley Whetter
06a1969d11
Fixed autodoc directives documenting properties as methods
4 years ago
Ashley Whetter
78b79583af
Implmented basic incremental building
...
Closes #191
4 years ago
Ashley Whetter
8e4cd49e1a
Dropped support for Python 2 and Sphinx 1.x/2.x.
...
Removed all old compatibility code.
4 years ago
Haggai Nuchi
a58b7ed45b
Update documenters.py
4 years ago
Ashley Whetter
4ba45cfacb
Can document inherited members
...
Closes #183
5 years ago
Ashley Whetter
520f3b0469
Fixed formatting
5 years ago
Ashley Whetter
a122f00d4a
Fix linting
5 years ago
Ashley Whetter
fd1cef5ced
Updated Autodoc directives for Sphinx 2.1 features
...
Added autoapidecorator directive.
Abides by autodoc_docstring_signature.
autoapifunction documents async functions.
Closes #166 .
5 years ago
Ashley Whetter
9fc96f2ddf
Added support for Sphinx 2.1
5 years ago
Ashley Whetter
2084f695bd
Can set an empty function signature in autodoc directives
6 years ago
Ashley Whetter
cac774c072
Added type annotation support to autodoc directives
6 years ago
Ashley Whetter
3db1fd1226
Fixed error when an invalid object is given to an autodoc directive
6 years ago
Ashley Whetter
8242f2ea13
Added Sphinx 2.0 support
6 years ago
Ashley Whetter
f77bf19800
Added Black formatting
6 years ago
Ashley Whetter
c6f34398b5
Fixed autodoc not documenting top level packages or modules
6 years ago
Ashley Whetter
66cf2ed4d0
Fixed autodoc not documenting anything in submodules or subpackages
6 years ago
Ashley Whetter
b789dcaa73
Fixed autodoc being unable to discover nested classes
6 years ago
Ashley Whetter
4ac85dd7af
Added autoapi directives for Python
6 years ago