Skip to content
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

Improve the compatibility of the doc between Github and RTD... #4800

Merged
merged 24 commits into from
Jun 28, 2018

Conversation

lrmoreno007
Copy link
Contributor

@lrmoreno007 lrmoreno007 commented Jun 8, 2018

Added the installation of the nbsphinx package that ensure the compatibility of the documentation between Github and RTD.

The admin in ReadTheDocs must ensure that:

  • In advanced setting, set requirements file: doc/requirements.txt <---- Use this exactly
  • In advanced setting, ensure Python interpreter are: CPython 2.x or CPython 3.x

Now we must always use GitHub links and now the links directly work in ReadtheDocs. Progressively we must change the links of the :doc: and :ref Sphinx native types that exist in the documentation (but first this PR must be approved).

Special thanks to: @mgeier

Read more... #4409

@lrmoreno007
Copy link
Contributor Author

lrmoreno007 commented Jun 8, 2018

I changed all the links with Sphinx native style (:doc: and :ref:) to GitHub style.

@d-a-v
Copy link
Collaborator

d-a-v commented Jun 9, 2018

Out of curiosity How are you viewing the result in readthedoc.io ?

In advanced setting, set requeriments file: doc/requeriments.txt <---- Use this exactly

Can you double-check the spelling ?

Note that I'm not questioning the validity of this PR.

@lrmoreno007
Copy link
Contributor Author

lrmoreno007 commented Jun 10, 2018

Excuse me, must be doc/requirements.txt

I see the results in my repo that is a translation to Spanish of this one.
http://esp8266-arduino-spanish.readthedocs.io/es/latest/index.html

Example:
Click in Software Serial
GITHUB https://github.com/lrmoreno007/ESP8266-Arduino-Spanish/blob/master/doc/reference.rst#serial
READTHEDOCS https://esp8266-arduino-spanish.readthedocs.io/es/latest/reference.html#serial

@devyte
Copy link
Collaborator

devyte commented Jun 17, 2018

@lrmoreno007 this sounds pretty cool. Let me know when you're done, and I'll merge.

@lrmoreno007
Copy link
Contributor Author

It's ready to merge if you want.

@devyte devyte merged commit 1eb0645 into esp8266:master Jun 28, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants