-
### Problem
The documentation generated with the [autoclass directive](https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#directive-autoclass) for python classes placed in a module …
-
### Feature request
The `.. toctree::` directive of Sphinx has an option `:reversed:` which will invert the order of entries: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.…
-
nsbgn updated
3 years ago
-
I'm encountering the docs failing to build when installing Ascent on Lassen via scrippts/build_ascent/build_ascent.sh
Cyrus has mentioned encountering the same while building with uberenv
```
B…
-
What about having a Sphinx documentation? Not "just a README"?
Here are some advantages:
- publish docs on readthedocs.org
- have a shorter README (summary + 1 example + links). Example here: http://d…
-
### Describe the bug
The use of an `only`-directive that is nested inside of a parent `only`-directive to conditionally include a directive of the Sphinx plugin [`breathe`](https://github.com/breat…
-
## Current Behavior
`tox -e docs` fails due to warnings
Example warning:
```console
WARNING: Summarised items should not include the current module. Replace 'pymovements.dataset.Dataset' with '…
-
From https://github.com/Qiskit/documentation/pull/2328, we have some pages like this:
![Image](https://github.com/user-attachments/assets/3adcd6b5-918c-47ac-91fd-710ce5e2248a)
This happens because o…
-
Our sphinx build on readthedocs.org is failing on an error likely related to `sphinx-autoapi`. Surprisingly, this is even though we had pinned the package version in the environment recipe:
```yaml…
-
## Context
- **Problem**: The current system lacks a secure method to authenticate requests to the workflow endpoints, which could lead to unauthorized access and potential data breaches.
- **Need…