47e5dcd707
Version 2.1.0
1 year ago
861b8e0f63
Document towncrier in the README
1 year ago
5fa927c682
Document the deprecation for other languages
1 year ago
f44080391b
Adjusted documentation around toctree editing
1 year ago
6b16e02de4
Let Sphinx handle adding domain directives to the toctree ( #374 )
...
* Remove ability to add domains to the toctree
* Add towncrier news fragment
1 year ago
007d9959a0
Fix towncrier not finding default branch in CI
1 year ago
58d653e557
Added basic type checking
1 year ago
1401facbc0
Integrated towncrier into the release workflow
1 year ago
2335e002f8
Version 2.0.1
1 year ago
03aefdf446
Fix more tests
1 year ago
384966090e
Fix more tests
1 year ago
3f8730aadd
Fix tests
1 year ago
94b255aecc
Added support for Python 3.11
1 year ago
1556b17ca8
Use the correct directives for a variable type and value ( #353 )
...
* Use the correct directives for a variable type and value
Co-authored-by: PerchunPak <perchunpak@gmail.com>
* Improve multiline value
* Add colons for strings
* Add another testcase
Co-authored-by: PerchunPak <perchunpak@gmail.com>
1 year ago
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)
1 year ago
94295a48cd
Don't document module level class attribute assignments
...
Fixes #341
2 years ago
0963c6d8a7
Added missing changelog entry
2 years ago
377a38550f
Add option autoapi_add_objects_to_toctree ( #284 )
2 years ago
6af1ca718a
Remove some autogenerated test data
2 years ago
847b6e5626
Correctly render tuples as tuples, not lists
...
Fixes #330
2 years ago
bf7bb08ef8
Version 2.0.0
2 years ago
a23e2ffe73
Render Python properties with the property directive
...
Fixes #352 .
2 years ago
d91c7aaa5c
Added missing changelog entry
2 years ago
c9edd8d1c6
Minor fixes (typos, http->https in links, types) ( #348 )
...
* Avoid http->https redirect, use https where possible
* Add autoapi_template_dir to existing array instead of re-declaring
* Typos
* Sphinx util uses int for verbosity in status_iterator
* Sphinx utils uses tuples for TypeField arguments
2 years ago
991ac220fd
Streamlined release process slightly
2 years ago
deb6944644
Version 1.9.0
2 years ago
ef1d4cb28e
Added changelog entry
2 years ago
0ac4dc5389
Fix kw-only marker getting ignored if first in the signature ( #340 )
...
Closes : #328
2 years ago
610bd10854
Added changelog entries
2 years ago
c40c3edd5c
Mark extension as parallel_read_safe ( #332 )
2 years ago
075736619f
Fix typos ( #331 )
2 years ago
432b9af5d5
Fix keyerror when using markdown sources ( #321 )
...
Setting `source_suffix = ".md"` led to the following cryptic error output:
Handler <function run_autoapi at 0x10841fc10> for event 'builder-inited' threw an exception (exception: 0)
This issue was that `app.config.source_suffix` is an `OrderedDict` object, which cannot be subscripted
using `[0]`, etc. Instead, use `next(iter(...))` to get the first element of the dictionary.
2 years ago
0e4f121a5d
Added missing changelog entries
2 years ago
185876a047
Limit signatures to 60 characters in summaries ( #311 )
2 years ago
fc6b8aec77
Fix comment typehints for methods/classmethods ( #300 )
...
* Fix comment typehints for methods and classmethods
Co-authored-by: Mathieu <923463-mathbou@users.noreply.gitlab.com>
2 years ago
517a6be383
Stop calling ``autodoc-process-docstring`` when docstring is empty
2 years ago
cd4e1fa59f
Fixed tests in Sphinx 5
2 years ago
17ad4b988e
Added new changelog entry
2 years ago
6028cb104c
Fail elegantly when no source files are found
...
Fixes #324
2 years ago
685d1d34c8
Updated to latest black formatting
2 years ago
71c6ceebe0
Fixed Python 3.10 erroring on Github
2 years ago
0b214b2ffd
Drop Python 3.6 and test in Python 3.10
2 years ago
19d217e177
Version 1.8.4
3 years ago
948f753a20
Fixed compatibility with astroid 2.7+.
...
Fixes #301
3 years ago
4d8f6387ca
Version 1.8.3
3 years ago
7cdc0dfae3
Fixed broken link to Jinja objects.inv
3 years ago
38c2089476
Removed prepare_docstring filter used for testing
3 years ago
7d7f042805
Fixed possible incorrect indentation in generated documentation.
...
Closes #299 .
3 years ago
354535190c
Version 1.8.2
3 years ago
2c5c87157a
Explicitly use the domain for generated directives
...
Closes #292
3 years ago
Ashley Whetter
Brandon Wiebe
davfsa
Ash Berlin-Taylor
Jakob Lykke Andersen
Bruno P. Kinoshita
Jeff Epler
Kian-Meng Ang
Nathan Glenn
Zachary Moon
Mathieu Bouzard