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.
* 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>
* 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)
* 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
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.