-
Hi, I'm migrating a documentation from the sphinx_rtd_theme to furo. This theme is awesome but it's missing the possibility edit the page on github directly from the docs website. This is very useful in collaborative projects. Are there any plans to implement this? Thank you! |
Beta Was this translation helpful? Give feedback.
Replies: 8 comments 19 replies
-
This is technically added by ReadTheDocs, if you're deploying your documentation there. That said, I definitely think this would be a good addition to the theme. A PR adding this to the current footer would be very welcome! I just "distracted" away from working on this theme for a bit, by https://github.com/pradyunsg/sphinx-basic-ng/ to revamp more of the Sphinx theme ecosystem at the moment. :) |
Beta Was this translation helpful? Give feedback.
-
Hi, I've been searching for the best position for the button in the last few days, I think it would fit best at the bottom of the sidebar. I came to this conclusion because it is easier to find than the footer button. This is a very important feature for a community contributed documentation. I've already made most of the changes as overrides to the theme in our project, but it would be great if we can contribute these features directly to the theme and enable them as options. I've also thought that the right sidebar could be customizable as the left one. I think it would be a nice place to link to translated pages, edit on git and maybe someone could also add their own components to it without fully overriding the sidebar. I have a public preview at Readthedocs if you'd like to see how it looks: Thank you! |
Beta Was this translation helpful? Give feedback.
-
I think that this could be solved by making the "Show source" link at the bottom point to GitHub instead of the |
Beta Was this translation helpful? Give feedback.
-
Was this added to furo theme? We need to add it furo based docs, can I get how it can be done? |
Beta Was this translation helpful? Give feedback.
-
This has been added in 76b7e73, and will be in the next release. :) |
Beta Was this translation helpful? Give feedback.
-
I see that "Show source" is now gone. I would prefer for it to link to GitHub source (with |
Beta Was this translation helpful? Give feedback.
-
Hey, I'd like to get support for this outside of Read the Docs. What would be involved in doing so? We (robusta.dev) would be happy to help out as we use Furo (see our docs) and would really like this feature. |
Beta Was this translation helpful? Give feedback.
-
I don't know if it's something specific to the packaging docs, but clicking the edit button on https://packaging.pypa.io/en/stable/specifiers.html goes to https://github.com/pypa/packaging/edit/d563917280d65a6ce2e622bd3d07438e1ee259f3/docs/specifiers.rst, which is a 404. d563917 is the commit the docs were built for, but I don't think GitHub allows edit URLs for specific commits. Furo gets the commit sha or branch name from ReadTheDocs and builds the URL from that. |
Beta Was this translation helpful? Give feedback.
This has been added in 76b7e73, and will be in the next release. :)