Archives/sphinx-autoapi
2
0
Fork 0
mirror of https://github.com/readthedocs/sphinx-autoapi synced 2024-11-17 21:25:35 +00:00
Code Issues Packages Projects Releases Wiki Activity
721 Commits 14 Branches 43 Tags 5 MiB
12f8197cfe
Commit Graph

721 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
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

---------

Co-authored-by: Ashley Whetter <ashley@awhetter.co.uk>
 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
Ashley Whetter
847b6e5626 Correctly render tuples as tuples, not lists 
Fixes #330
 2022-10-23 14:09:48 -07:00
Ashley Whetter
bf7bb08ef8 Version 2.0.0 2022-09-27 16:31:33 -07:00
Ashley Whetter
a23e2ffe73 Render Python properties with the property directive 
Fixes #352.
 2022-09-27 15:57:44 -07:00
Ashley Whetter
d91c7aaa5c Added missing changelog entry 2022-09-27 12:20:25 -07:00
Bruno P. Kinoshita
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
 2022-09-27 12:18:48 -07:00
Ashley Whetter
991ac220fd Streamlined release process slightly 2022-07-25 12:00:54 -07:00
Ashley Whetter
deb6944644 Version 1.9.0 2022-07-25 11:53:50 -07:00
Ashley Whetter
ef1d4cb28e Added changelog entry 2022-07-25 11:47:10 -07:00
Jeff Epler
0ac4dc5389 Fix kw-only marker getting ignored if first in the signature (#340) 
Closes: #328
 2022-07-25 11:46:30 -07:00
Ashley Whetter
610bd10854 Added changelog entries 2022-07-25 11:37:27 -07:00
Ash Berlin-Taylor
c40c3edd5c
Mark extension as parallel_read_safe (#332) 2022-07-25 11:36:28 -07:00
Kian-Meng Ang
075736619f
Fix typos (#331) 2022-07-25 11:34:17 -07:00
Nathan Glenn
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.
 2022-07-25 11:32:11 -07:00
Ashley Whetter
0e4f121a5d Added missing changelog entries 2022-07-25 10:31:53 -07:00
Zachary Moon
185876a047
Limit signatures to 60 characters in summaries (#311) 2022-07-25 10:30:57 -07:00
Mathieu Bouzard
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>
 2022-07-25 10:27:03 -07:00
Ashley Whetter
517a6be383 Stop calling `autodoc-process-docstring` when docstring is empty 2022-07-25 10:22:38 -07:00
Ashley Whetter
cd4e1fa59f Fixed tests in Sphinx 5 2022-07-25 10:20:51 -07:00
Ashley Whetter
17ad4b988e Added new changelog entry 2022-02-08 21:50:57 -08:00
Ashley Whetter
6028cb104c Fail elegantly when no source files are found 
Fixes #324
 2022-02-08 21:44:16 -08:00
Ashley Whetter
685d1d34c8 Updated to latest black formatting 2022-02-08 19:37:55 -08:00
Ashley Whetter
71c6ceebe0 Fixed Python 3.10 erroring on Github 2021-12-23 01:44:38 -08:00
Ashley Whetter
0b214b2ffd Drop Python 3.6 and test in Python 3.10 2021-12-23 01:15:07 -08:00