92437c9af7
Removed old pylint pragmas
12 months ago
a22ae9262a
Removed support for documenting languages other than Python
...
For the reasons why, see #248
12 months ago
7b90b43f94
Add news
12 months ago
4ea04f241e
Ensure tooltip is always a str
12 months ago
9d970a6a66
Rename master to main
12 months ago
2219dcdd7a
Fix compatibility with astroid v3
12 months ago
0ba883ab89
Replace usage of deprecated astroid.NodeNG.doc
...
Closes #392
12 months ago
6f4e12a00c
Start testing on Python 3.12
...
Closes #390
12 months ago
1e6b1fa4c4
Build docs in Python 3.11 on readthedocs
...
Closes #389
12 months ago
0ac1e11359
Version 2.1.1
1 year ago
c3c6e15d16
Added missing changelog entry
1 year ago
86cf7e2b87
Fix getting 'orig_path' for 'viewcode_follow_imported'
1 year ago
38a615ff74
Types used in PEP-604 union syntax can be linked with intersphinx
...
Closes #366
1 year ago
7fa3998438
Fix separated type comments for arguments not merging correctly in Python 3.7
1 year ago
434ef8305a
Tests build HTML and parse it to validate structure
1 year ago
1ae7b78128
Fix class overrides not rendering correctly
1 year ago
0a557fc95e
Replaced usage of unidecode with anyascii to fix license incompatibilities
...
Closes #382
1 year ago
aab9f814b8
Made it clearer how to customise what objects AutoAPI will document.
...
Closes #339
1 year ago
9c774d4242
Overhauled documentation landing page
1 year ago
12f8197cfe
Added a basic dev container
1 year ago
1715dfe0b5
Fix "document isn't included" warning when using autoapi_add_toctree_entry
...
Closes #319
1 year ago
8ffcd0fd67
Corrected formatting
1 year ago
b4687e6ddc
Fix conditional depending on sphinx version
1 year ago
0ec649a555
Remove redundant wheel dep from pyproject.toml ( #375 )
...
Remove the redundant `wheel` dependency, as it is added by the backend
automatically. Listing it explicitly in the documentation was
a historical mistake and has been fixed since, see:
f7d30a9529
1 year ago
336f52e2e9
Added missing deprecation warning for other language support
1 year ago
85739d513e
Switched to Google style docstrings
1 year ago
a43c6fde2b
Switched linter from pylint to ruff
1 year ago
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
Ashley Whetter
Ken Odegard
Z-Fran
Marco Sirabella
Michał Górny
Brandon Wiebe
davfsa
Ash Berlin-Taylor
Jakob Lykke Andersen