-
Currently, our various classes are described in the documentation via explicit `.. class` `.. method` directives. We should move to autodoc, and move these docstrings inline.
This will reduce the d…
-
## Brief
`apidoc` forces that the `SPHINX_APIDOC_OPTIONS` are starting and ending with a `:`, but there are sphinx options which do not end with a `:`, which are then unusable.
## Problem statem…
raabf updated
2 years ago
-
At the moment, the steps involved in generating documentation for most ETS projects are
- run sphinx-apidoc to generate the api documetation
- run sphinx-build to build the docs
This is proble…
-
Hi. Thanks for your great work on sphinx-multiversion.
I have a API documentation generated using `sphinx-apidoc` and `sphinx-build`.
I would like to generate a versioned api documentation using _sp…
-
An option before the push that would allow us to enter a popular apidoc call for example "sphinx-apidoc -f -o . .." With this we could completely automate sphinx docs on push.
-
### Describe the bug
Referencing a method defined in the parent class from a child class with `` :meth:`x` `` does not work.
It looks as it should but there is no link.
As a workaround it is poss…
erzoe updated
2 weeks ago
-
The sub package filter in the `create_package_file` function also removes implicit namespace packages (i.e., https://github.com/goerz/better-apidoc/blob/e1e4c59f709bb2f5d0b2a8f2515f9ad4e63a0bf2/better…
-
Hi,
I know sphinx-apidoc already has the -d option to set the maxdepth in the main modules TOC. However, I was wondering if this or another option could be used to add :maxdepth: to the toctree of ea…
arski updated
2 years ago
-
I tried to use the c++ documentation generation on a codebase that has some macros in it, but the sphinx build failed. Mostly macro usage of the form
```
PROJECT_ATTRIBUTES int some_function();
```…
-
```
+ py.test
========================================================================================= test session starts ==========================================================================…