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
728 Commits 14 Branches 43 Tags 5 MiB
38a615ff74
Commit Graph

112 Commits

Author SHA1 Message Date
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
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
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
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
Jakob Lykke Andersen
377a38550f
Add option autoapi_add_objects_to_toctree (#284) 2022-10-23 14:16:42 -07:00
Ash Berlin-Taylor
c40c3edd5c
Mark extension as parallel_read_safe (#332) 2022-07-25 11:36:28 -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
685d1d34c8 Updated to latest black formatting 2022-02-08 19:37:55 -08: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
613eff53a7 Fixed type annotations being shown for only a single module 
Closes #273
 2021-04-24 19:43:39 -07:00
Kamil Breguła
57253a9f84 Generate rst files in src directory 2021-04-12 20:33:33 -07:00
Joseph Yu
b9a6fcd350 Minor internal test warnings fixes 2021-03-19 21:56:04 -07:00
Ashley Whetter
a8d07b610f Can edit the Jinja environment 
Closes #200
 2020-11-13 22:47:32 -08:00
Ashley Whetter
06a1969d11 Fixed autodoc directives documenting properties as methods 2020-11-13 21:28:47 -08:00
Ashley Whetter
e281137654 Fixed raising unnecessary deprecation warning 
Closes #244
 2020-10-26 16:22:26 -07:00
Ashley Whetter
78b79583af Implmented basic incremental building 
Closes #191
 2020-10-26 16:13:38 -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
0667de4037 Release preparation 2020-08-31 21:59:16 -07:00
Taku Fukada
b2b5f62847 Fix #234: Inject TOCs just after doctrees are read 2020-08-02 09:43:45 -07:00
Ashley Whetter
f5182a2291 Declare the extension as parallel safe 
Closes #222
 2020-07-11 19:53:00 -07:00
Ashley Whetter
cd9b9ca0fe Added the imported-members AutoAPI option 
Closes #204
 2020-05-16 17:36:52 -07:00
Ashley Whetter
b52378fa51 Added autoapi_member_order option 
Closes #201
 2020-05-16 15:28:43 -07:00
Ashley Whetter
0d95377bbf Accept template directory relative to conf.py 
Closes #184
 2020-04-05 18:50:32 -07:00
Ashley Whetter
4ba45cfacb Can document inherited members 
Closes #183
 2020-02-01 12:53:40 -08:00
Ashley Whetter
265b4ae562 Added show-inheritance 
Also turned autoapi_include_inheritance_graphs into a
show-inheritance-diagram AutoAPI option to be more consistent
with show-inheritance.

Partially implements #183
 2020-01-25 14:38:22 -08:00
Ashley Whetter
076427e6ae Added inheritance diagrams support 
Close #140
 2020-01-11 17:29:36 -08:00
Olivier Samyn 🎻
7ca958fe57 feat: Support implicit namespaces for python >= 3.3 2020-01-03 08:39:06 -08:00
Ashley Whetter
520f3b0469 Fixed formatting 2019-10-05 16:09:26 -07:00
Ashley Whetter
a122f00d4a Fix linting 2019-10-05 16:05:37 -07:00
Daniel Daniels
a114af76dc Added autoapi-skip-member event 2019-10-05 13:55:18 -07:00
danields761
be324b10bf Made dependencies of other languages optional (#171) 
* Fixes #170

* Makes sphinxcontrib-golangdomain and
sphinxcontrib-dotnetdomain to be optional
packages
* Adds check that appropriate dependencies of
a specified api-type installed during the
extension initialisation
* Adds appropriate tests
 2019-09-01 14:44:17 -07:00
Ashley Whetter
02b0c0a098 Made it more clear which file causes an error 2019-08-25 17:04:30 -07:00
Ashley Whetter
86a2aeb6d7 Fixed some unicode decode errors 2019-08-25 15:53:58 -07:00
Ashley Whetter
fd1cef5ced Updated Autodoc directives for Sphinx 2.1 features 
Added autoapidecorator directive.
Abides by autodoc_docstring_signature.
autoapifunction documents async functions.

Closes #166.
 2019-08-10 23:08:03 -07:00
Ashley Whetter
0cee730693 Do not add a toctree entry when not generating docs 2019-04-21 15:40:00 -07:00
Ashley Whetter
f77bf19800 Added Black formatting 2019-01-26 21:20:45 -08:00
Ashley Whetter
c4fe76ef23 Removed references to old css and js files 2019-01-26 17:16:22 -08:00
Ashley Whetter
2cf80b1569 Fixed Sphinx logger deprecation warnings 2019-01-26 17:11:12 -08:00
Ashley Whetter
aac53178eb Fixed error parsing files with unicode docstrings 2018-11-13 11:07:36 -08:00
Ashley Whetter
c3f3cc33de Added viewcode support for imported members 2018-08-20 09:37:43 -07:00
Ashley Whetter
8d4fb4b1c3 Can document a public python API 
Closes #153
 2018-08-13 12:18:56 -07:00
Ashley Whetter
9e9c28e15b Can opt to write manual documentation 2018-08-10 09:00:54 -07:00
Ashley Whetter
8a965bb15a Fixed lint error 2018-08-07 14:33:42 -07:00
Ashley Whetter
bc65e766c3 Made it easier to remove default index page 
Also removed autoapi_add_api_root_toctree config option
because it is less useful now.

Closes #152
 2018-08-06 16:23:33 -07:00
Ashley Whetter
4ac85dd7af Added autoapi directives for Python 2018-08-06 14:19:12 -07:00
Ashley Whetter
6ca62f16c9 Can control how __init__ docstring is displayed 2018-06-05 22:47:32 -07:00
Ashley Whetter
9f6f7d0b5d Added support for viewcode 2018-05-24 07:50:39 -07:00