rename this repo, to emphasize docs/sphinx

[velle]

pyqgis normally refers to the Python binding for QGIS.

Yet the https://github.com/qgis/pyqgis repo is concerned with only one technical detail of the entire thing, ie autogenerating html docs of the pyqgis API, using the tool Sphinx.

I'm sure almost every pyqgis user must have visited this github project in vain at some time :)

Why does it have this name? Was there a time, where pyqgis (the API) actually resided here?

In any case, I believe it would be common sense to rename the repo into "pyqgis-sphinx" or similar.

Renaming it to "pyqgis-docs" would be an improvement, but with that name users still might go there with issues concerned with the documentation itself (typos, incorrect information, etc.).

Sincerely

[jfbourdon]

I'm sure almost every pyqgis user must have visited this github project in vain at some time :)

I concur, I have once been this user and it took me a while to understand that it wasn't the place at all if I wanted to edit some part of the doc. In addition to (or in lieu of) a rename of the repo, a note could be added to the main README.md saying explicitly that any change to the documentation itseft has be to made elsewhere.

Also, in order to avoid getting lost pyqgis users here, I think that adding a button saying "Edit on GitHub" at the top of each page of https://qgis.org/pyqgis/ linking to right file on the main QGIS repo would help a lot.

[DelazJ]

Also, in order to avoid getting lost pyqgis users here, I think that adding a button saying "Edit on GitHub" at the top of each page of https://qgis.org/pyqgis/ linking to right file on the main QGIS repo would help a lot.

See #37 for some context on this request

a note could be added to the main README.md saying explicitly that any change to the documentation itseft has be to made elsewhere

Pull request welcome 😉
And this information could also be placed in the (to be renamed) "bug reporting and fixes" section of the PyQGIS website main page.