cytoscape / cytoscape-manual

Markdown version of Cytoscape manual
Creative Commons Zero v1.0 Universal
11 stars 23 forks source link

Fix broken version selector in ReadTheDocs #70

Closed khanspers closed 10 months ago

khanspers commented 10 months ago

The lower-left version selector drop-down doesn't work on 'latest': https://manual.cytoscape.org/en/latest

Not sure why but could have something to do with the 'sphinx_rtd_theme'.

Note: The selector works fine on stable and 3.10.1 versions (which is what we link to from website and UI), since these were built before the latest set of changes that introduced this bug.

bdemchak commented 10 months ago

Does not seem to happen on py4cytoscape documents ... either latest or 1.9.0

khanspers commented 10 months ago

There was a jQuery error in the browser console; found this https://github.com/readthedocs/sphinx_rtd_theme/issues/1452.

Adding extensions = ["sphinxcontrib.jquery"] solves the problem.

bdemchak commented 10 months ago

I see ... I think the difference is that the requirements.txt file for py4cytoscape specifies a specific sphinx version that didn't have this problem:

sphinx==3.5.4 jinja2==3.0.3 pandas networkx requests colorbrewer chardet igraph sphinx_autodoc_typehints sphinx_rtd_theme ipykernel decorator backoff colour

Thanks for posting your solution.