Brandon Wiebe
6317148f0d
Replace usage of deprecated astroid.NodeNG.doc in inheritance_diagrams.py
2023-09-26 12:50:57 -07:00
Ashley Whetter
4d1bec044a
Removed support for Python 3.7
2023-09-24 08:57:47 -07:00
Niels Wouda
cf8abe579f
Import fallback for older versions of Sphinx
2023-09-24 08:42:57 -07:00
Niels Wouda
0186a3c978
Replace usage of deprecated sphinx.util.status_iterator
2023-09-24 08:42:57 -07:00
Ashley Whetter
92437c9af7
Removed old pylint pragmas
2023-07-08 10:38:24 -07:00
Ashley Whetter
a22ae9262a
Removed support for documenting languages other than Python
...
For the reasons why, see #248
2023-07-08 10:35:38 -07:00
Ken Odegard
7b90b43f94
Add news
2023-07-08 10:01:55 -07:00
Ken Odegard
4ea04f241e
Ensure tooltip is always a str
2023-07-08 10:01:55 -07:00
Ashley Whetter
9d970a6a66
Rename master to main
2023-07-06 21:30:10 -07:00
Ashley Whetter
2219dcdd7a
Fix compatibility with astroid v3
2023-07-06 21:25:32 -07:00
Ashley Whetter
0ba883ab89
Replace usage of deprecated astroid.NodeNG.doc
...
Closes #392
2023-07-06 21:14:32 -07:00
Ashley Whetter
6f4e12a00c
Start testing on Python 3.12
...
Closes #390
2023-07-06 19:57:58 -07:00
Ashley Whetter
1e6b1fa4c4
Build docs in Python 3.11 on readthedocs
...
Closes #389
2023-07-06 19:51:26 -07:00
Ashley Whetter
0ac1e11359
Version 2.1.1
2023-06-10 10:58:13 -07:00
Ashley Whetter
c3c6e15d16
Added missing changelog entry
2023-06-10 10:36:30 -07:00
Z-Fran
86cf7e2b87
Fix getting 'orig_path' for 'viewcode_follow_imported'
2023-06-10 10:18:17 -07:00
Ashley Whetter
38a615ff74
Types used in PEP-604 union syntax can be linked with intersphinx
...
Closes #366
2023-06-10 10:07:20 -07:00
Ashley Whetter
7fa3998438
Fix separated type comments for arguments not merging correctly in Python 3.7
2023-05-30 20:33:59 -07:00
Ashley Whetter
434ef8305a
Tests build HTML and parse it to validate structure
2023-05-30 18:59:20 -07:00
Ashley Whetter
1ae7b78128
Fix class overrides not rendering correctly
2023-05-22 19:58:40 -07:00
Ashley Whetter
0a557fc95e
Replaced usage of unidecode with anyascii to fix license incompatibilities
...
Closes #382
2023-05-22 10:10:05 -07:00
Ashley Whetter
aab9f814b8
Made it clearer how to customise what objects AutoAPI will document.
...
Closes #339
2023-05-22 09:38:24 -07:00
Ashley Whetter
9c774d4242
Overhauled documentation landing page
2023-04-30 09:51:52 -07:00
Ashley Whetter
12f8197cfe
Added a basic dev container
2023-04-29 21:21:22 -07:00
Ashley Whetter
1715dfe0b5
Fix "document isn't included" warning when using autoapi_add_toctree_entry
...
Closes #319
2023-04-10 16:49:21 -07:00
Ashley Whetter
8ffcd0fd67
Corrected formatting
2023-04-07 10:45:55 -07:00
Marco Sirabella
b4687e6ddc
Fix conditional depending on sphinx version
2023-04-07 10:31:26 -07:00
Michał Górny
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
2023-04-07 10:30:46 -07:00
Ashley Whetter
336f52e2e9
Added missing deprecation warning for other language support
2023-04-07 10:23:12 -07:00
Ashley Whetter
85739d513e
Switched to Google style docstrings
2023-03-29 17:44:57 -07:00
Ashley Whetter
a43c6fde2b
Switched linter from pylint to ruff
2023-03-29 17:30:21 -07:00
Ashley Whetter
47e5dcd707
Version 2.1.0
2023-03-28 09:45:29 -07:00
Ashley Whetter
861b8e0f63
Document towncrier in the README
2023-03-28 09:43:30 -07:00
Ashley Whetter
5fa927c682
Document the deprecation for other languages
2023-03-28 09:25:41 -07:00
Ashley Whetter
f44080391b
Adjusted documentation around toctree editing
2023-03-28 09:17:05 -07:00
Brandon Wiebe
6b16e02de4
Let Sphinx handle adding domain directives to the toctree ( #374 )
...
* Remove ability to add domains to the toctree
* Add towncrier news fragment
2023-03-28 09:13:28 -07:00
Ashley Whetter
007d9959a0
Fix towncrier not finding default branch in CI
2023-03-27 13:18:04 -07:00
Ashley Whetter
58d653e557
Added basic type checking
2023-03-22 22:33:11 -07:00
Ashley Whetter
1401facbc0
Integrated towncrier into the release workflow
2023-03-22 21:50:01 -07:00
Ashley Whetter
2335e002f8
Version 2.0.1
2023-01-16 21:36:19 -08:00
Ashley Whetter
03aefdf446
Fix more tests
2023-01-16 21:29:00 -08:00
Ashley Whetter
384966090e
Fix more tests
2023-01-16 21:26:18 -08:00
Ashley Whetter
3f8730aadd
Fix tests
2023-01-16 21:14:38 -08:00
Ashley Whetter
94b255aecc
Added support for Python 3.11
2023-01-16 20:16:19 -08:00
davfsa
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>
2023-01-04 20:35:40 -08:00
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)
2023-01-04 20:33:25 -08:00
Ashley Whetter
94295a48cd
Don't document module level class attribute assignments
...
Fixes #341
2022-10-23 15:13:53 -07:00
Ashley Whetter
0963c6d8a7
Added missing changelog entry
2022-10-23 14:18:07 -07:00
Jakob Lykke Andersen
377a38550f
Add option autoapi_add_objects_to_toctree ( #284 )
2022-10-23 14:16:42 -07:00
Ashley Whetter
6af1ca718a
Remove some autogenerated test data
2022-10-23 14:12:22 -07:00
