Commit Graph

721 Commits (12f8197cfe93a146454ce19d6fb44338b1bccc3b)
 

Author SHA1 Message Date
Ashley Whetter 12f8197cfe Added a basic dev container 1 year ago
Ashley Whetter 1715dfe0b5 Fix "document isn't included" warning when using autoapi_add_toctree_entry
Closes #319
1 year ago
Ashley Whetter 8ffcd0fd67 Corrected formatting 1 year ago
Marco Sirabella b4687e6ddc Fix conditional depending on sphinx version 1 year ago
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>
1 year ago
Ashley Whetter 336f52e2e9 Added missing deprecation warning for other language support 1 year ago
Ashley Whetter 85739d513e Switched to Google style docstrings 1 year ago
Ashley Whetter a43c6fde2b Switched linter from pylint to ruff 1 year ago
Ashley Whetter 47e5dcd707 Version 2.1.0 1 year ago
Ashley Whetter 861b8e0f63 Document towncrier in the README 1 year ago
Ashley Whetter 5fa927c682 Document the deprecation for other languages 1 year ago
Ashley Whetter f44080391b Adjusted documentation around toctree editing 1 year ago
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
1 year ago
Ashley Whetter 007d9959a0 Fix towncrier not finding default branch in CI 1 year ago
Ashley Whetter 58d653e557 Added basic type checking 1 year ago
Ashley Whetter 1401facbc0 Integrated towncrier into the release workflow 1 year ago
Ashley Whetter 2335e002f8 Version 2.0.1 1 year ago
Ashley Whetter 03aefdf446 Fix more tests 1 year ago
Ashley Whetter 384966090e Fix more tests 1 year ago
Ashley Whetter 3f8730aadd Fix tests 1 year ago
Ashley Whetter 94b255aecc Added support for Python 3.11 1 year ago
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>
1 year 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)
1 year ago
Ashley Whetter 94295a48cd Don't document module level class attribute assignments
Fixes #341
2 years ago
Ashley Whetter 0963c6d8a7 Added missing changelog entry 2 years ago
Jakob Lykke Andersen 377a38550f
Add option autoapi_add_objects_to_toctree (#284) 2 years ago
Ashley Whetter 6af1ca718a Remove some autogenerated test data 2 years ago
Ashley Whetter 847b6e5626 Correctly render tuples as tuples, not lists
Fixes #330
2 years ago
Ashley Whetter bf7bb08ef8 Version 2.0.0 2 years ago
Ashley Whetter a23e2ffe73 Render Python properties with the property directive
Fixes #352.
2 years ago
Ashley Whetter d91c7aaa5c Added missing changelog entry 2 years ago
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
2 years ago
Ashley Whetter 991ac220fd Streamlined release process slightly 2 years ago
Ashley Whetter deb6944644 Version 1.9.0 2 years ago
Ashley Whetter ef1d4cb28e Added changelog entry 2 years ago
Jeff Epler 0ac4dc5389 Fix kw-only marker getting ignored if first in the signature (#340)
Closes: #328
2 years ago
Ashley Whetter 610bd10854 Added changelog entries 2 years ago
Ash Berlin-Taylor c40c3edd5c
Mark extension as parallel_read_safe (#332) 2 years ago
Kian-Meng Ang 075736619f
Fix typos (#331) 2 years ago
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.
2 years ago
Ashley Whetter 0e4f121a5d Added missing changelog entries 2 years ago
Zachary Moon 185876a047
Limit signatures to 60 characters in summaries (#311) 2 years ago
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>
2 years ago
Ashley Whetter 517a6be383 Stop calling ``autodoc-process-docstring`` when docstring is empty 2 years ago
Ashley Whetter cd4e1fa59f Fixed tests in Sphinx 5 2 years ago
Ashley Whetter 17ad4b988e Added new changelog entry 2 years ago
Ashley Whetter 6028cb104c Fail elegantly when no source files are found
Fixes #324
2 years ago
Ashley Whetter 685d1d34c8 Updated to latest black formatting 2 years ago
Ashley Whetter 71c6ceebe0 Fixed Python 3.10 erroring on Github 3 years ago
Ashley Whetter 0b214b2ffd Drop Python 3.6 and test in Python 3.10 3 years ago