Commit Graph

450 Commits (feat/single-page-option)

Author SHA1 Message Date
Ashley Whetter 53de7fd42d Version 3.1.0b0 1 month ago
Ashley Whetter f23b079e7d Stop using xrefs in page titles
Closes #427
1 month ago
Ashley Whetter bc71226c3b Render PEP-695 type aliases as TypeAlias assignments
Partially addresses #414
2 months ago
Ashley Whetter 007077a7db Refactor mapper classes into their bases
This separate used to exist to support parsing multiple languages,
which we no longer do.
2 months ago
Ashley Whetter a6558dcfc2 Various fixes for own page output
Also added tests for own page output.
Fix some inherited members always being rendered.
Own page members of an entity are linked to after the docstring
of the parent entity.
Fix entities below the "class" level that have their own page
from rendering incorrectly.
Rename "single page output" to "own page output". An entity does
not have a "single page" when its members are spread across
their own pages.
Properties are linked to on their parent classes page.
Children not present in `__all__` are not rendered.
Fixed emitting ignore event twice for methods.
Corrected documentation around `imported-members` to reflect that it
applies only to objects imported into a package, not modules.
Fixed path error on Windows.
2 months ago
Jorge Martinez 2a603b8ac0 Recursive rendering of children with their own page 2 months ago
Ashley Whetter 93fb571a7e Basic tests for single page rendering 2 months ago
Jorge Martinez Garrido ecd47ea456 Initial implementation of customisable single page output 2 months ago
George Zhang 0d69974c19 Preserve strings inside Literal type annotations 2 months ago
George Zhang 34a96700ea Replace usage of deprecated docutils.nodes.Node.traverse 2 months ago
Ashley Whetter 67c0b5f821 Fix type checking against latest Sphinx 2 months ago
Ashley Whetter c4db7eb14a Fix IndexError when a module docstring contains only a heading 3 months ago
laggykiller 823c146b3a Correct handling of `__init__.pyi`
Closes #405
3 months ago
Ashley Whetter bbb50f68ae Reformatted to latest stable black style 3 months ago
Ashley Whetter 006142dbad Version 3.0.0 8 months ago
Brandon Wiebe 6317148f0d Replace usage of deprecated astroid.NodeNG.doc in inheritance_diagrams.py 8 months ago
Ashley Whetter 4d1bec044a Removed support for Python 3.7 8 months ago
Niels Wouda cf8abe579f Import fallback for older versions of Sphinx 8 months ago
Niels Wouda 0186a3c978 Replace usage of deprecated sphinx.util.status_iterator 8 months ago
Ashley Whetter 92437c9af7 Removed old pylint pragmas 11 months ago
Ashley Whetter a22ae9262a Removed support for documenting languages other than Python
For the reasons why, see #248
11 months ago
Ken Odegard 4ea04f241e Ensure tooltip is always a str 11 months ago
Ashley Whetter 2219dcdd7a Fix compatibility with astroid v3 11 months ago
Ashley Whetter 0ba883ab89 Replace usage of deprecated astroid.NodeNG.doc
Closes #392
11 months ago
Ashley Whetter 0ac1e11359 Version 2.1.1 11 months ago
Ashley Whetter c3c6e15d16 Added missing changelog entry 11 months ago
Z-Fran 86cf7e2b87 Fix getting 'orig_path' for 'viewcode_follow_imported' 11 months ago
Ashley Whetter 38a615ff74 Types used in PEP-604 union syntax can be linked with intersphinx
Closes #366
11 months ago
Ashley Whetter 7fa3998438 Fix separated type comments for arguments not merging correctly in Python 3.7 12 months ago
Ashley Whetter 1ae7b78128 Fix class overrides not rendering correctly 1 year ago
Ashley Whetter 0a557fc95e Replaced usage of unidecode with anyascii to fix license incompatibilities
Closes #382
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 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
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 58d653e557 Added basic type checking 1 year ago
Ashley Whetter 2335e002f8 Version 2.0.1 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
Jakob Lykke Andersen 377a38550f
Add option autoapi_add_objects_to_toctree (#284) 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
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 deb6944644 Version 1.9.0 2 years ago