EbookFoundation
/
readthedocs.org
mirror of https://github.com/EbookFoundation/readthedocs.org.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add short sentence on GitHub edit view 

The GitHub edit link only works if the user is already logged into GitHub. Otherwise GitHub will throw a nondescript 404 page (which doesn't prompt the user to login unfortunately). Just made a small note of this in the documentation.
rtd2
changlinli 2013-09-25 10:39:12 -04:00
parent e95958fd58
commit ad19c132b8
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/features.rst
View File

@ -6,7 +6,7 @@ This will serve as a list of all of the features that Read the Docs currently ha
Github Integration
------------------
We now support linking to GitHub by default in the sidebar. It links to the page on GitHub, and directly links to the edit view as well. This should help people quickly update typos and send pull requests to contribute to project documentation.
We now support linking to GitHub by default in the sidebar. It links to the page on GitHub, and directly links to the edit view as well. This should help people quickly update typos and send pull requests to contribute to project documentation. Note that users must be logged in to GitHub in order to directly jump into the edit view via the "Edit on GitHub" link, otherwise they'll be presented with an unfortunate 404 page. The user does not, however, need to be logged on to use the "Show in GitHub" link.
If you want to integrate this into your own theme, the following variables are available in your custom templates: