search

cytoscape / cytoscape-manual

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

All of the .md hyperlinks are broken #41

Closed hydrosquall closed 5 years ago

hydrosquall commented 5 years ago

Hi, thanks for the great work on this project! I wanted to flag an issue that I noticed when browsing the docs today.

The issue is that all the links to .md files work on on Github, but break when the page is rendered to html.

For example, click on Groups on this page in the text Most often, Groups are more functional and easier to use.

http://manual.cytoscape.org/en/stable/Nested_Networks.html

A fix could be to either update all the links from .md to HTML, or to update the script which turns the markdown files into HTML to transform all the markdown links into HTML ones.

hydrosquall commented 5 years ago

A coworker suggested looking into using this library in the Sphinx config to help with converting the URLs correctly in a non-manual way:

https://github.com/rtfd/recommonmark

ritwikagarwal commented 5 years ago

I think the issue is fixed now as I can easily render all the links on html currently and correctly. Thanks.

hydrosquall commented 5 years ago

It looks like this was done through the good work of @khanspers - thank you :)!

(Via commits like this: https://github.com/cytoscape/cytoscape-manual/commit/29c4cef647c81019ca36015856872014ac0f3d4f )

I think it could still be worthwhile to see about automating this in the build step to avoid similar manual work in the future, but I'll leave it to the project maintainers to decide if this issue should be left open.

joshtburdick commented 10 months ago

This seems to have recurred, at least when I click on https://manual.cytoscape.org/en/stable/Nested_Networks.html

I'm using Chrome, on Mac OS X.

(I haven't used Cytoscape much, but the documentation otherwise looks well-done.)