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

58 Commits

Author SHA1 Message Date
Ashley Whetter
a22ae9262a Removed support for documenting languages other than Python 
For the reasons why, see #248
 2023-07-08 10:35:38 -07:00
Ashley Whetter
6f4e12a00c Start testing on Python 3.12 
Closes #390
 2023-07-06 19:57:58 -07:00
Ashley Whetter
0ac1e11359 Version 2.1.1 2023-06-10 10:58:13 -07:00
Ashley Whetter
434ef8305a Tests build HTML and parse it to validate structure 2023-05-30 18:59:20 -07:00
Ashley Whetter
aab9f814b8 Made it clearer how to customise what objects AutoAPI will document. 
Closes #339
 2023-05-22 09:38:24 -07:00
Ashley Whetter
9c774d4242 Overhauled documentation landing page 2023-04-30 09:51:52 -07:00
Ashley Whetter
a43c6fde2b Switched linter from pylint to ruff 2023-03-29 17:30:21 -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
94b255aecc Added support for Python 3.11 2023-01-16 20:16:19 -08:00
Ashley Whetter
991ac220fd Streamlined release process slightly 2022-07-25 12:00:54 -07:00
Ashley Whetter
0b214b2ffd Drop Python 3.6 and test in Python 3.10 2021-12-23 01:15:07 -08:00
Ashley Whetter
66f3734afa Start testing in Github Actions 2021-04-04 20:23:24 -07:00
Ashley Whetter
826bb2badd Converted tests to pytest style 2021-04-03 19:01:27 -07:00
Ashley Whetter
9372bdb9f1 Package with PEP-517 2021-04-03 18:39:08 -07:00
Ashley Whetter
565c43d99b Can run with tox 4 2021-04-02 19:20:54 -07:00
Ashley Whetter
23bee3db99 Added support for Sphinx 3.5 2021-03-19 23:09:37 -07:00
Ashley Whetter
82eb508fe0 Added support for Sphinx 3.3 and 3.4 2021-01-31 10:12:42 -08:00
Ashley Whetter
714c0609ba Added Python 3.9 support 2021-01-20 14:59:15 -08:00
Ashley Whetter
31d4beb959 Readthedocs uses Python 3.8 2020-10-07 22:25:08 -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
Ashley Whetter
f5823855ba Added Sphinx 3.1 testing 2020-07-11 19:14:03 -07:00
Ashley Whetter
8b9f0c23b5 Corrected autoapi_options default value 2020-05-16 18:00:04 -07:00
Matthijs van der Burgh
8f91c14199 Show black diff 2020-05-16 14:09:22 -07:00
Ashley Whetter
6bfe168abe Updated Travis Python versions 2020-04-05 20:09:07 -07:00
Ashley Whetter
5794902b23 Support Sphinx 2.4 and 3.0 2020-04-05 20:03:05 -07:00
Ashley Whetter
fc1d78f758 Python 3.8 support 2020-01-11 14:37:13 -08:00
Ashley Whetter
a122f00d4a Fix linting 2019-10-05 16:05:37 -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
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
9fc96f2ddf Added support for Sphinx 2.1 2019-06-23 13:25:25 -07:00
Ashley Whetter
6d39780ae4 Fixed tox setup 2019-06-23 11:55:15 -07:00
Ashley Whetter
7230330686 Documentation overhaul 2019-04-21 15:38:22 -07:00
Ashley Whetter
8242f2ea13 Added Sphinx 2.0 support 2019-04-06 10:04:15 -07:00
Ashley Whetter
5d648c6fa8 Stopped pinning black version 2019-03-30 11:47:11 -07:00
Ashley Whetter
f77bf19800 Added Black formatting 2019-01-26 21:20:45 -08:00
Ashley Whetter
dfe82ae94e Dropped support for Sphinx<1.6 2019-01-26 16:26:39 -08:00
Ashley Whetter
e1962d8bd8 Added Python 3.7 testing 
Also made Sphinx 1.8 testing use stable version
 2018-11-14 22:40:55 -08:00
Ashley Whetter
0e478b2837 Added Sphinx 1.8.0b1 testing 2018-08-20 11:08:07 -07:00
Ashley Whetter
11a11ce740 Added sphinx 1.7 testing 2018-05-08 22:41:35 -07:00
Anthony Johnson
77306dd25b Upgrade testing 
Conflicts:
	tox.ini
 2017-11-08 16:04:25 -08:00
Ashley Whetter
67ab54761f Added Python 3.6 tests 2017-11-05 15:03:18 -08:00
Ashley Whetter
0c9ed87abf Fixed sphinx 1.3 tests using latest sphinx 2017-11-05 14:18:43 -08:00
Ashley Whetter
a1a3f05202 Fix for Sphinx 1.6 2017-11-05 14:18:43 -08:00
Anthony Johnson
0faeb500ee More fixes 2017-04-07 13:12:10 -07:00
Anthony Johnson
8da39241a7 Fix tox config 2017-04-07 12:01:17 -07:00
Anthony Johnson
3c6e0e4015 Start altering the pydocstyle AST parser for our needs 
This forks some of the pydocstyle AST parser into out mapper. Eventually, some
of the other operations such as parsing arguments and performing full name
lookup can be moved in as well. For now, this is not doing any extra assignment
tracking/etc, several of these operations will just throw this information out.

Refs #99
 2017-04-07 11:46:57 -07:00
Anthony Johnson
f607d5e1db Improvements to pydocstyle Python parsing 
* Moves relative path parsing away from the base mapper implementation
* Change argument parsing from splitting first line of source with ',' to use
  AST traversal instead. This is not complete, but mostly PoC for now. Full
  traversal into argument type nodes will allow us to get nested dict() etc.
  We should open a ticket to track this work
* Cleans up some of the templates to reduce duplicate titles
* Adds a directive for nesting rST from constructs that might have headings.
  Remove the first heading in this case to address the case where a module has a
  docstring with a heading up front
* Adds tests
* Replaces example module with module that has more failing cases of parsing

Closes #78
Fixes #80
Fixes #81
Fixes #82
Fixes #83
Fixes #84
Fixes #85
 2016-11-02 16:29:28 -07:00