-
Notifications
You must be signed in to change notification settings - Fork 8
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
Labels
bug
Defects or glitches reported by users or developers
Comments
Found a workaround for this issue: removing 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
AFAICT, the autosummary templates in https:/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:/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: