Skip to content

RTFD default theme: links to the page source on github #226

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

Closed
pkra opened this issue Jul 25, 2012 · 5 comments
Closed

RTFD default theme: links to the page source on github #226

pkra opened this issue Jul 25, 2012 · 5 comments

Comments

@pkra
Copy link

pkra commented Jul 25, 2012

This is another idea/feature request for the RTFD default theme.

If the source is on github, it would be useful to have a link to github's source of each page to quickly correct typos etc.

Kind of an "edit" button, if you will.

@ericholscher
Copy link
Member

This has something similar in it. I'd love to see it implemented across the whole site, if you have any ideas on how to do it.

http://opensourcehacker.com/2012/07/26/open-source-project-documentation-on-github-and-readthedocs-org-a-year-later/

@Maks3w
Copy link

Maks3w commented Jul 30, 2012

We have implemented something similar for ZF2 docs

We need harcode the URLs because we don't know how to get the following parameters:

  • Repository
  • Branch
  • Locale

@pkra
Copy link
Author

pkra commented Jul 31, 2012

Thanks!

I don't know enough about RTFD to make any informed comment on how to do this site-wide, but I think I can at least use your helpful examples.

@ericholscher
Copy link
Member

This is now done, and is enabled for anyone using the main RTD theme. It takes a rebuild to work, and let me know if people see any issues.

@pkra
Copy link
Author

pkra commented Nov 27, 2012

Awesome! Thanks for adding it.

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

No branches or pull requests

3 participants