enable edit on github button #94
Conversation
sgbaird
requested review from
Scienfitz,
AdrianSosic and
AVHopp
as code owners
|
|
| @@ -215,6 +215,9 @@ | |||
| # Logos. Location is relative to _static folder. | |||
| "light_logo": "logo1.svg", # Logo for light mode | |||
| "dark_logo": "logo1.svg", # Logo for dark mode | |||
| "source_repository": "https://github.com/emdgroup/baybe/", | |||
| "source_branch": "main", | |||
| "source_directory": "docs/", | |||
| } | |||
|
|
|||
| # Ignored links for linkcheck | |||
There was a problem hiding this comment.
please add this change to CHANGELOG
| @@ -215,6 +215,9 @@ | |||
| # Logos. Location is relative to _static folder. | |||
| "light_logo": "logo1.svg", # Logo for light mode | |||
| "dark_logo": "logo1.svg", # Logo for dark mode | |||
| "source_repository": "https://github.com/emdgroup/baybe/", | |||
| "source_branch": "main", | |||
| "source_directory": "docs/", | |||
| } | |||
|
|
|||
| # Ignored links for linkcheck | |||
There was a problem hiding this comment.
tried it locally, this does not seem to work for autodocumentation and examples eg:
Reason is likely because these are converted from .py files and are not directly written as .md
@AdrianSosic @AVHopp do we care about that? It only works for user guides but overall I think its a good suggestion
There was a problem hiding this comment.
If we can fix this such that it works for more than just the files that are available as .md files, then I do not see why we should not include this button. However, I also get 404 when building this locally. We would first need to investigate whether this button works as expected when being deployed on github pages.
There was a problem hiding this comment.
Hi @sgbaird, thanks a lot for the suggestion, I think having the button is a very good idea. But as long as we get the 404 errors for most pages, I think we cannot include it. Do you have any clue if this is configurable, i.e. can we restrict the appearance of the button to certain pages? If not, I would perhaps open an issue on the furo repo and ask for help there...
There was a problem hiding this comment.
Thank you for testing this out, I probably should have done a local build first. I will explore a bit more, but no worries if this one doesn't go through. I wasn't expecting the 404 errors 😅
There was a problem hiding this comment.
The best way to test the documentation would be to not only build it locally, but also build it as the github pages for your fork. This should ensure that 404 errors and stuff like that do not just happen because the local structure of the converted files is different to the way they are organized on github 😄
Scienfitz
added
wontfix
|
Hello @sgbaird I just wanted to ask if there are any updates on this PR resp. what the state here is :) |
@AVHopp I've started my troubleshooting. I have a mirror GitHub Pages site running, and I'm testing out a few other things. Thank you for the ping/reminder! Will try to have either a fix or a decision to drop by the end of the week 👍 |
|
Hello @sgbaird were your tests successful? |
|
Unfortunately, no. I may come back and try sometime later. We can close for now. |
https://pradyunsg.me/furo/customisation/edit-button/
(see also pradyunsg/furo#114)