-
### Describe the bug
I have 2 packages: `p1` and `p2`.
In `p1` I define an enum `MyEnum` and a dataclass `MyClass`, which has 2 fields, one of which is a value of `MyEnum`, so it's annotated lik…
-
I am currently using Sphinx and building html pages using the command `sphinx-build docs build/html`.
I installed multiversion using: `pip install sphinx-multiversion`
```
$ pip list
sphinx-…
-
### What is an issue?
## Problem
I cannot build the document on my MacBook, and my colleagues also cannot. It might be the problem due to the dependencies, but I have no exact idea how to fix this. …
-
### Describe the bug
Looks like pytest test suite fails in 7 units related to typing checks.
### How to Reproduce
I'm packaging your module as an rpm package so I'm using the typical PEP517 b…
-
When trying to document a project that's using SQLAlchemy, I get the following error message:
```
WARNING: error while formatting signature for module.DatabaseModel.created_at: Handler for event …
-
I'm getting the following when trying to build our docs with `sphinx-autodoc2`:
```
[Autodoc2] Determining files to write ...
[Autodoc2] Writing modules...[ 0%] src …
-
Currently we run examples once with sphinx gallery and once with test-examples. This is mainly done to ensure our coverage is rightly reported.
However, in practice the 2 can be done together.
A s…
-
Sphinx has an autodoc feature to automatically get doc strings from the code. Thes seems a nice feature to implement
-
### Describe the bug
According to https://www.sphinx-doc.org/en/master/extdev/deprecated.html, `sphinx.util.import_object` is deprecated and `importlib.import_module` is suggested as alternative.
…
-
Thank you for creating this library!
I'm struggling a bit with the instructions to get "autodoc_pydantic" and "autosummary" to play nicely together. I was hoping you could clarify the instructions …