Hello, I'm trying to fix some links in the documentation of this project 
https://github.com/esp8266/Arduino and I can't find a way to make the links 
compatible on GitHub and Sphinx (ReadTheDocs).

=====================================

If I use this method:

`link to readme <esp8266/readme.rst>`__

The links work perfectly on GitHub, but don't work on Sphinx(ReadTheDocs).

Example in the project:  Click in the link "Generic ESP8266 modules"
https://github.com/esp8266/Arduino/blob/master/doc/faq/a01-espcomm_sync-failed.rst
https://arduino-esp8266.readthedocs.io/en/latest/faq/a01-espcomm_sync-failed.html

========================================

If I use this method:

: doc: `link to readme <esp8266wifi/readme>`

The links work perfectly on Sphinx(ReadTheDocs), but don't work on GitHub.

Example in the project: Click in the link "ESP8266WiFi library 
documentation"
https://github.com/esp8266/Arduino/blob/master/doc/libraries.rst
https://arduino-esp8266.readthedocs.io/en/latest/libraries.html

===============================================

Can someone help me to fix it?

Regards.

P.D.: Issue in GitHub: https://github.com/esp8266/Arduino/issues/4409

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Reply via email to