-
I use these extensions:
* https://github.com/tox-dev/sphinx-autodoc-typehints
* https://github.com/zwang123/sphinx-autodoc-defaultargs
They work for regular public functions, but anything annotat…
-
Please, see https://github.com/sphinx-doc/sphinx/issues/11460 first.
So, after having read that, you should know that someone suggested me to open the same issue here. I don't know if this is rela…
-
### Describe the bug
`autodoc_class_signature = "separated"` option will cause class without `__init__` raise a warning and can't build with `-W`
![image](https://github.com/sphinx-doc/sphinx/as…
-
The docstrings of property setters are ignored by sphinx autodoc, only possible 'solution' I've found is:
https://stackoverflow.com/questions/71713284/types-of-setter-arguments-not-showing-in-sphin…
-
**Describe the bug**
When `autodoc_typehints="description"`, type hint comments for classes aren't fully resolved, even with `autoclass_content="both"`.
**To Reproduce**
Create `module.py` with t…
-
Looks like documentation build fails with sphinx 5.x
```console
+ /usr/bin/sphinx-build -n -T -b man doc-source build/sphinx/man
Running Sphinx v5.0.2
Traceback (most recent call last):
File …
-
### Describe the bug
When `autodoc_class_signature` is set to `separated`, a type alias config as follows
```python
autodoc_type_aliases: dict[str, str] = {
"BotT": "~discord.ext.commands.Bot …
-
I've run into a situation where `sphinx-autodoc-typehints` is inserting the rtype signature without creating space between rtype and the previous paragraph so it isn't being rendered correctly in the …
-
### Describe the bug
The following script
```python
class MyClass:
"An instance of this class holds a list.\n\n:param r: the list as a string"
l: list
def __init__(self,r:str): self.l = li…
-
Sphinx 8.*+ has [new format of `intersphinx_mapping`](https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_mapping), which makes generating documentation to fail:…
mcepl updated
3 weeks ago