-
Sphinx supports doc comments in the form of `#:`.
This is also part of the expected and documented syntax for the google and numpy formats, supported in the sphinx implementation but not here.
T…
-
### Describe the bug
I have a project that uses Pydantic. I recently updated it to v2 and I still use sphinx==7.2.6. I noticed in the autogenerated source documentation, that models have the method m…
-
(Broader context at the end).
This issue is to discuss a potential PHEP to replace the "documentation" portion of the existing PyHC standards: to lay out what looks like the current standards, and …
-
[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…
-
autodoc comes with the parameter `autodoc_member_order`, which can be set to one of {'alphabetical', 'groubwise', 'bysource'}: http://www.sphinx-doc.org/en/stable/ext/autodoc.html#confval-autodoc_memb…
-
i'm having a strange issue where importing a method from a lib that had a "from Qt import QtWidgets " line, crashes sphinx with out error....
my rst file was the following auto module settings...
…
-
https://github.com/sphinx-doc/sphinx/issues/7630
This issue is here to track the above issue in sphinx to see when we can have support for our new typestub files to fill/complete the API docs.
Wou…
-
https://pypi.org/project/sphinx-autodoc-typehints/
Instead of
```python
def format_unit(value, unit):
"""
Formats the given value as a human readable string using the given units.
…
-
When type hints are shown in the signature, they are not passed through `typehints_formatter`.
## Example
```
package
├── docs
│ ├── conf.py
│ └── index.rst
├── my_module
│ └── __i…
-
# Description
In PR #313 an new Sphinx autodoc extension was added by @huard. This extension generates a nicely formatted Sphinx documentation of a PyWPS process.
This extension relies on Sphin…