ansys / ansys/ansys-sphinx-theme
Autosummary template for methods broken?
- Dominant language
- Python
- Stars
- 32
- Forks
- 7
- Avg merge
- 18h 20m
- Merged PRs (30d)
- 36
Description
AFAICT, the autosummary templates in https://github.com/ansys/ansys-sphinx-theme/tree/main/src/ansys_sphinx_theme/_templates/autosummary are not used when building a documentation with `ansys-sphinx-theme`.
For example, [this branch](https://github.com/greschd/ansys-sphinx-theme/tree/junk/test_method_doc) adds a `Complex.method`, which should be documented by the `autosummary` directive in the docs here: https://github.com/ansys/ansys-sphinx-theme/blob/main/doc/source/class_documentation.rst#autosummary-directive
The result is that the `method` shows up in the overview of `Complex`, but is not clickable (i.e., its full documentation does not exist).
This can be fixed by copying the `src/ansys_sphinx_theme/_templates/autosummary` to `doc/_templates/autosummary`, but that shouldn't be necessary.
Contributor guide
Research direction
Start by comparing src/ansys_sphinx_theme/_templates/autosummary with the documentation build configuration under doc, then reproduce the Complex.method example from the linked branch and class_documentation.rst. The work is done when the packaged autosummary templates are used without copying them into doc/_templates and Complex.method has clickable full documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100