search

hubverse-org / hubDocs

https://hubverse.io
5 stars 6 forks source link

"suggest an edit" doesn't have the right directory path #31

Closed nickreich closed 1 year ago

nickreich commented 1 year ago

I think there is a missing "source" in the path where this "suggest an edit" link is looking

image

Gives the error:

The 'Infectious-Disease-Modeling-Hubs/hubDocs' repository doesn't contain the 'docs/index.md' path in 'main'.
micokoch commented 1 year ago

I think the correct link should be: https://github.com/Infectious-Disease-Modeling-Hubs/hubDocs/edit/main/docs/source/index.md

micokoch commented 1 year ago

It seems the problem comes from 'sphinx_book_theme'. There seems to be a new pre-release which will be ready soon which may address this. In the meantime, I have two suggestions:

  1. Comment out #"use_edit_page_button": True until this is fixed in a new release.
  3. Use "use_issues_button": True until this is fixed, which seems like a good temporary place to suggest edits.

I have made these edits in my fork and they work well.

micokoch commented 1 year ago

https://github.com/micokoch/hubDocs/blob/main/docs/source/conf.py