search

ansys / ansys-sphinx-theme

PyData-based Sphinx theme from the PyAnsys community
https://sphinxdocs.ansys.com
MIT License
23 stars 8 forks source link

Multiple links in API reference TOC Tree appear on same line #233

Closed Andy-Grigg closed 1 year ago

Andy-Grigg commented 1 year ago

The HTML docs generated for ansys-openapi-common show this in the API reference TOC tree (0.9.6 and 0.9.5):

image

Compared to the current output in the published docs (package version 0.7.1)

image

This then produces a strange layout when clicking one of the links:

image

We do not have multi-version docs set up yet for openapi-common, so see the artifacts generated by the CI in this PR https://github.com/pyansys/openapi-common/pull/338 for the actual generated HTML. It looks like the change occurred somewhere between 0.7.1 and 0.9.5, I just only noticed when checking the 0.9.5 to 0.9.6 PR.

Revathyvenugopal162 commented 1 year ago

@Andy-Grigg it is because of the sidebar_nav_bar.html present in the templates, which overrides the existing sidebar settings by pydata and ansys-sphinx-theme. i removed the html files. and hopefully it will solve the issue.

Andy-Grigg commented 1 year ago

Thanks @Revathyvenugopal162 , your commit has indeed solved this issue. See https://github.com/pyansys/openapi-common/pull/338/commits/eb857e49857bcc738657a687c612b30b0da8af34 for the commit.

Closing this issue.