Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Autosummary template for methods broken? #77

Open
greschd opened this issue Jun 14, 2022 · 1 comment
Open

Autosummary template for methods broken? #77

greschd opened this issue Jun 14, 2022 · 1 comment
Labels
bug Defects or glitches reported by users or developers

Comments

@greschd
Copy link
Member

greschd commented Jun 14, 2022

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 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.

@greschd greschd added the bug Defects or glitches reported by users or developers label Jun 14, 2022
@greschd
Copy link
Member Author

greschd commented Jun 14, 2022

Found a workaround for this issue: removing templates_path = ["_templates"] from conf.py seems to fix it.

Maybe that's not the "right" solution, since we still want to be able to define templates locally?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Defects or glitches reported by users or developers
Projects
None yet
Development

No branches or pull requests

1 participant