-
### Describe the bug
below error occurs while buliding documentation
```
WARNING: error while formatting arguments for example.ex1.ExampleClass: 'typing.ParamSpec' object has no attribute '__or…
wldhg updated
8 months ago
-
I am following this tutorial (https://panel.holoviz.org/how_to/wasm/sphinx.html), but unfortunately did not manage to build the documentation which show's the panel in sphix due to an import error bas…
-
**Is your feature request related to a problem? Please describe.**
The only easy way to place the [`math` directive][1] exactly where I want using autodoc is to include it in the docstring, I can't…
-
[sphinx-autoapi](https://sphinx-autoapi.readthedocs.io/en/latest/) is a faster alternative to [autodoc](https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html) which does not require insta…
-
## Description
Since this library is still in development and breaking changes are not too disruptive, I think it's worth making the public API stricter **right now**.
Through some mix of the fo…
-
I have a python package module that imports 3rd party modules which aren't included in the sphinx documentation. So I added these modules to mock imports in the ``conf.py``
```python
autodoc_mock_…
-
I normally [sphinx-napoleon](http://www.sphinx-doc.org/en/stable/ext/napoleon.html) and the "google style" for docs. It would be great if `sphinx-autodoc-annotation` supported this!
``` python
class …
sotte updated
7 years ago
-
### Describe the bug
**context**
I added `myst-nb` to an existing documentation that includes a `.ipynb` file and invoke `make html`.
**expectation**
A neat result.
**bug**
But instead 🐛`Unb…
-
### Describe the bug
Sphinx autodoc is useful for automating documentation. I'm trying to use Sphinx's autodoc extension to document tasks/workflows using the `automodule` directive, and any function…
-
### Describe the bug
Building large packages takes a lot of time, most of which is cost on resolving cross-references.
When building a package of 70MB and 3399 files ([azure-mgmt-containerservi…