timothycrosley / portray

Your Project with Great Documentation.
MIT License
860 stars 72 forks source link

edit URI changed from MkDocs #88

Open garfieldnate opened 2 years ago

garfieldnate commented 2 years ago

MkDocs uses edit/master as the default edit_uri value, so without documentation stating otherwise I expected this to be the same in Portray, particularly because the documentation on edit_uri points to the documentation in MkDocs. Unifying this value with MkDocs would break clients, but it would be helpful to just let the user know that this is happening. A single-line message like, "edit_uri not set by user, defaulting to edit/main" (or edit/default) would be helpful.

robbintt commented 1 year ago

This is configurable. I tested it just now, as I had the same problem with an old repo:

E.g. in PyProject.toml:

[tool.portray.mkdocs]
edit_uri = "edit/master"