Archives/sphinx-autoapi
2
0
Fork 0
mirror of https://github.com/readthedocs/sphinx-autoapi synced 2024-11-11 19:10:58 +00:00
Code Issues Packages Projects Releases Wiki Activity
726 Commits 14 Branches 43 Tags 5 MiB
434ef8305a
Commit Graph

186 Commits

Author SHA1 Message Date
Ashley Whetter
434ef8305a Tests build HTML and parse it to validate structure 2023-05-30 18:59:20 -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
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
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
58d653e557 Added basic type checking 2023-03-22 22:33:11 -07: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
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
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
a23e2ffe73 Render Python properties with the property directive 
Fixes #352.
 2022-09-27 15:57:44 -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
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
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
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
cd4e1fa59f Fixed tests in Sphinx 5 2022-07-25 10:20:51 -07: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
38c2089476 Removed prepare_docstring filter used for testing 2021-07-31 18:25:25 -07:00
Ashley Whetter
7d7f042805 Fixed possible incorrect indentation in generated documentation. 
Closes #299.
 2021-07-31 18:06:12 -07:00
Ashley Whetter
2c5c87157a Explicitly use the domain for generated directives 
Closes #292
 2021-06-27 17:25:36 -07:00
Ashley Whetter
17ffa2d1b6 Fixed failure to build out of source conf.py files 
Closes #293
 2021-06-25 20:14:33 -07:00
Ashley Whetter
08e61b93ef Fixed displaying "self" in class signatures 2021-06-25 19:30:54 -07:00
Ashley Whetter
5faec73073 Fixed error when parsing a class with no constructor 2021-06-21 23:10:52 -07:00
Ashley Whetter
613eff53a7 Fixed type annotations being shown for only a single module 
Closes #273
 2021-04-24 19:43:39 -07:00
Ashley Whetter
86a6d1059c Refactored dotnet error to raise an exception properly 2021-04-12 20:32:37 -07:00
Ashley Whetter
826bb2badd Converted tests to pytest style 2021-04-03 19:01:27 -07:00
Ashley Whetter
bf8f50dc97 Fixed type hints still showing when setting autodoc_typehints 
Closes #273
 2021-04-02 20:08:34 -07:00
Ashley Whetter
643fed0ccd Can resolve the qualified paths of parameters to generics 
Closes #265
 2021-03-19 23:11:52 -07:00
Joseph Yu
5435536988 Multiline string are displayed correctly 2021-03-19 22:03:04 -07:00
Joseph Yu
b9a6fcd350 Minor internal test warnings fixes 2021-03-19 21:56:04 -07:00
Ashley Whetter
471c870a53 Do not inherit redundant docstrings 
Closes #240
 2021-01-31 16:12:19 -08:00
Ashley Whetter
24109875e1 The overload signatures of __init__ methods are documented 
Fixes #260
 2021-01-31 15:34:40 -08:00
Ashley Whetter
73bb2d6105 The fully qualified path of objects are included type annotations 2021-01-31 10:14:52 -08:00
Ashley Whetter
a8d07b610f Can edit the Jinja environment 
Closes #200
 2020-11-13 22:47:32 -08:00
Ashley Whetter
78b79583af Implmented basic incremental building 
Closes #191
 2020-10-26 16:13:38 -07:00
Ash Berlin-Taylor
5ee7dbef59 Correctly parse Metaclasses 
Fixes #246
 2020-10-25 19:17:07 -07:00
Ashley Whetter
7330297a83 Fixed tests on Python <3.8 2020-10-07 22:46:58 -07:00
Ashley Whetter
8256daa090 Fixed test setup 2020-10-07 22:18:43 -07:00
Ashley Whetter
6f0299356a Can use type hints as parameter types and return types 2020-10-05 13:18:35 -07:00
Ashley Whetter
8e4cd49e1a Dropped support for Python 2 and Sphinx 1.x/2.x. 
Removed all old compatibility code.
 2020-10-03 12:21:25 -07:00
Ashley Whetter
9a5f22d7d6 One day I'll learn to run black before pushing... 2020-08-31 22:07:51 -07:00
Ashley Whetter
0667de4037 Release preparation 2020-08-31 21:59:16 -07:00