Archives/sphinx-autoapi
2
0
Fork 0
mirror of https://github.com/readthedocs/sphinx-autoapi synced 2024-11-19 15:25:31 +00:00
Code Issues Packages Projects Releases Wiki Activity
551 Commits 14 Branches 43 Tags 5 MiB
d71ac5f250
Commit Graph

551 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Olivier Samyn
d71ac5f250 fix: Make the linter happy 2020-01-03 08:39:06 -08:00
Olivier Samyn
cca3a781ee fix: correct stop condition in sphinx <2.0 and add a stop guard. 2020-01-03 08:39:06 -08:00
Olivier Samyn
a836795d17 doc: Add autoapi_python_use_implicit_namespaces config value description 
+
 2020-01-03 08:39:06 -08:00
Olivier Samyn
5f085ca47f test: add implicit namespace checks 2020-01-03 08:39:06 -08:00
Olivier Samyn 🎻
7ca958fe57 feat: Support implicit namespaces for python >= 3.3 2020-01-03 08:39:06 -08:00
Ashley Whetter
4c927b2a3f
Minor fix in how_to.rst (#185) 2020-01-03 08:33:44 -08:00
Ashley Whetter
2af3d462bf Fixed formatting of the table in the tutorials 2020-01-03 08:32:15 -08:00
Yuji Tabata
7cc6b72c96
Minor fix in how_to.rst 2019-12-03 13:05:03 +09:00
Ashley Whetter
daa5ce24a5 Version 1.2.1 2019-10-09 20:02:29 -07:00
Ashley Whetter
74889a9d07 "Invalid desc node" warning no longer raised for autodoc-style directives 2019-10-09 19:53:26 -07:00
Ashley Whetter
e06fa71dbc Version 1.2.0 2019-10-05 17:01:36 -07:00
Ashley Whetter
28301f1ba4 Fix linting again 2019-10-05 17:00:05 -07:00
Ashley Whetter
520f3b0469 Fixed formatting 2019-10-05 16:09:26 -07:00
Ashley Whetter
b8fddf9c0b Added some missing documentation 2019-10-05 16:05:37 -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
谷月轩
f6649ebde4 Include methods in child class (#176) 2019-10-05 12:39:50 -07:00
Ashley Whetter
900072e99b Added documentation for optional dependencies 2019-09-07 17:25:03 -07:00
Ashley Whetter
45ff03a3ad Disable linting for now 2019-09-07 17:03:21 -07:00
Armand BENETEAU
fa3b0b3f70 Fix Go documentation generation (#172) 
* Correction of the "parameters" accessibility problem in the Go mapper

The "parameters" attributes of the GoPythonMapper class instance was
not accessible from the "output_rst" function used to create the .rst
file. Thanks to this correction, the parameters are now accessible.

* Enhance the template used to genertae the .rst file from the .go source file

This modification allows to create a .rst file compatible with the
last version of Sphinx. Without this correction, the creation of documentation
was not possible. A "make html" command lead to an "AssertionError" Exception.
 2019-09-03 20:55:52 -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
34d02faa2f Custom argument formatting 
Closes #162
 2019-08-07 23:23:21 -07:00
Ashley Whetter
46c577eda1 Support for async and other Sphinx 2.1 method directive options 2019-07-17 20:59:20 -07:00
Eric Holscher
a5d369aea4
Change rtfd -> readthedocs 2019-07-15 10:09:05 -07:00
Martín Gaitán
6b6aae95fc fix typo on subsection's title (#167) 2019-07-02 16:18:08 -07:00
Ashley Whetter
0b947a028e v1.1.0 2019-06-23 13:43:28 -07:00
Ashley Whetter
6629e0b10f Update appveyor to Python 3.7 2019-06-23 13:30:17 -07:00
Ashley Whetter
9fc96f2ddf Added support for Sphinx 2.1 2019-06-23 13:25:25 -07:00
Ashley Whetter
589826e90c Can override ignoring local imports in modules by using __all__ 2019-06-23 12:36:58 -07:00
Ashley Whetter
9d45eed4d0 Fixed incorrect formatting of functions and methods 2019-06-23 11:55:15 -07:00
Ashley Whetter
6d39780ae4 Fixed tox setup 2019-06-23 11:55:15 -07:00
Ashley Whetter
f3ab2ef6e2 Fixed some dead links in the README 2019-05-03 09:42:39 -07:00
Ashley Whetter
9735f43a8d v1.0.0 2019-04-24 15:04:37 -07:00
Ashley Whetter
2084f695bd Can set an empty function signature in autodoc directives 2019-04-21 23:01:46 -07:00
Ashley Whetter
6f4b4efef5 Corrected version to Python to skip tests for 2019-04-21 22:56:43 -07:00
Ashley Whetter
cac774c072 Added type annotation support to autodoc directives 2019-04-21 22:45:29 -07:00
Ashley Whetter
b90284f0fe Support basic type annotations 
Closes #139
 2019-04-21 21:58:25 -07:00
Ashley Whetter
43250fbf99 Fixed another typo 2019-04-21 15:50:58 -07:00
Ashley Whetter
0d3a328a35 Fixed typo in README 2019-04-21 15:50:10 -07:00
Ashley Whetter
ec091aa706 Removed some old tests 2019-04-21 15:45:06 -07:00
Ashley Whetter
b5dfea1c6d Removed some dead code 2019-04-21 15:40:00 -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
3db1fd1226 Fixed error when an invalid object is given to an autodoc directive 2019-04-21 15:38:22 -07:00
Ashley Whetter
7230330686 Documentation overhaul 2019-04-21 15:38:22 -07:00
Ashley Whetter
dd58809d89 Added support for parsing stub files 
Closes #100
 2019-04-06 11:25:39 -07:00
Ashley Whetter
b5d83f8472 Fixed tests 2019-04-06 11:15:18 -07:00
Ashley Whetter
3b299be332 Tidied up index page 2019-04-06 10:33:38 -07:00