sphinx-autoapi

sphinx-autoapi copied to clipboard

Not sure who is at fault here (maybe me!), but I am using `sphinx-autoapi` with [numpydoc validations](https://numpydoc.readthedocs.io/en/latest/validation.html) activated via sphinx and I get lots of warnings like ``` WARNING: [numpydoc]...

HealthyPear

🐞 **Problem** I see that the latest run for the CI/CD took place about four months ago since the opening of this issue. Thus, it would be great to have...

jorgepiloto

Excluding directories

3

AutoAPI makes the reasonable assumption that one's directory structure will look like: ``` mypackage/ ├── docs directory │   ├── ... │   └── ... ├── code directory │   ├── ... │  ...

evildmp

Add pound colon #: parsing

6

Hello, Sphinx allows for documenting comments starting with "#:", above or just after the variable. I am not able to use such comments with Read the Docs autoapi, which is...

lwpiotr

Markdown support

9

I'm currently moving our tutorial notebooks/documentation from RST with `jupyter-sphinx` to Markdown with `myst-nb`. We'd eventually like to also move docstrings to be written in myst-markdown. To that end I'm...

renefritze

Hi, I am struggling to sort the entries of the `.. toctree::` in documentation generated with `autoapi`. I have one `.piy` sutbfile for each of my project's submodule and it...

jdumas

Implicit namespace packages do not generate documentation

6

Hi! Thanks for your work on this package, it really saved me from a lot of autosummary-related misery. I've noticed a bug: the `autoapi_python_use_implicit_namespaces` option is fantastic, but it doesn't...

Yoshanuikabundi

Wrong namespace resolution for base clases when using star import

1

### The issue 🐞 Consider the following project: ```console . ├── package/ │ ├──__init__.py │   ├── module_A.py │   └── module_B.py ├── conf.py └── index.rst ``` The content of each file:...

jorgepiloto

We frequently get bug reports with no method of reproducing the issue. Create a bug report template that makes providing this information a requirements.

AWhetter

type hints are not added correctly to google style docstrings

1

## Problem description I found a buggy behavior when the autoapi is configured like this in `conf.py`: ```py autodoc_typehints = "description" autoapi_type = "python" autoapi_file_pattern = "*.py" autoapi_python_class_content = "both"...

arwedus