sphinx-autodoc2

sphinx-autodoc2 copied to clipboard

⬆️ Update sphinx requirement from <7,>=4.0.0 to >=4.0.0,<8

4

Updates the requirements on [sphinx](https://github.com/sphinx-doc/sphinx) to permit the latest version. Release notes Sourced from sphinx's releases. Sphinx 7.2.6 Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog Sourced from sphinx's changelog. Release 7.2.6 (released Sep 13,...

dependabot[bot]

Add support `index_filename` option to `autodoc2`.

3

Add support `index_filename` option. Example: ```python # docs/conf.py autodoc2_index_filename = "index.md" ```

jag-k

The nested id for the tag appears to be solved, but not sure if it affects other part or not. What I did was setting a breakpoint at https://github.com/sphinx-doc/sphinx/blob/bfce4f54b0fc010b04f0d17ad8b9d47d8c279e1f/sphinx/domains/python/_object.py#L212 and...

krerkkiat

0.5.0: pytest is failing in `tests/test_render.py::test_sphinx_build_directives` unit

4

I'm packaging your module as an rpm package so I'm using the typical PEP517 based build, install and test cycle used on building packages from non-root account. - `python3 -sBm...

kloczek

On building my packages I'm using `sphinx-build` command with `-n` switch which shows warmings about missing references. These are not critical issues. Full sphinx outpt is in attachment [python-sphinx-autodoc2.sphix_warnins.txt](https://github.com/sphinx-extensions2/sphinx-autodoc2/files/14624128/python-sphinx-autodoc2.sphix_warnins.txt)

kloczek

Support autodoc_typehints setting

3

The [`autodoc_typehints`](https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_typehints) setting lets you put the type hints in the parameter list instead of the signature. This is also how https://github.com/tox-dev/sphinx-autodoc-typehints handles type hints, which can be a lot...

blink1073

autodoc2-object and -summary outputs full path

3

When using autodoc2-object and -summary, instead of outputting `Baz` for instance it outputs the full path, meaning `Foo.Bar.Baz`. This duplicates the path when trying to press to an object (hello.rst#Foo.Bar.Foo.Bar.Baz),...

DatGuy1

Tested it works, we just need to test the target is in the current module. ``` def render_method(self, item: ItemData) -> t.Iterable[str]: """Create the content for a method.""" short_name =...

FabriceSalvaire

`chrisjsewell/sphinx-autodoc2` -> `sphinx-extensions2/sphinx-autodoc2`. Caught this because of `linkcheck`

LecrisUT

Hello, My Python package doesn't work well with static analysis since I'm setting `__all__` programmatically at runtime. I also have docstrings which are dynamically modified upon import, avoiding a lot...

mm21