We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
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.
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
Complex.method
autosummary
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).
method
Complex
This can be fixed by copying the src/ansys_sphinx_theme/_templates/autosummary to doc/_templates/autosummary, but that shouldn't be necessary.
src/ansys_sphinx_theme/_templates/autosummary
doc/_templates/autosummary
The text was updated successfully, but these errors were encountered:
Found a workaround for this issue: removing templates_path = ["_templates"] from conf.py seems to fix it.
templates_path = ["_templates"]
conf.py
Maybe that's not the "right" solution, since we still want to be able to define templates locally?
Sorry, something went wrong.
No branches or pull requests
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 theautosummary
directive in the docs here: https://github.com/ansys/ansys-sphinx-theme/blob/main/doc/source/class_documentation.rst#autosummary-directiveThe result is that the
method
shows up in the overview ofComplex
, 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
todoc/_templates/autosummary
, but that shouldn't be necessary.The text was updated successfully, but these errors were encountered: