Fix the edit link for API documentation

The swh-docs building process symlinks the documentation for individual modules into the swh-docs tree to generate a single Sphinx project. The “Edit this page” link therefore needs to point to the right repository on GitLab in these case.

We try to implement this using the edit_page_url_template option of the PyData theme, see: https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/source-buttons.html#custom-edit-url

We can take advantage that it’s a Jinja2 template to recognize that API documentation file path starts with devel/swh- and adjust accordingly. This is a bit of a hack, but we can hope it’ll be enough as long as we stay consistent.

• Closes: #4735 (closed)

added activity::Implementation label

added 1 commit

• d4c4ac42 - Fix the edit link for API documentation

Compare with previous version

Jenkins job DDOC/builds #77 succeeded .
See Console Output and Coverage Report for more details.

Jenkins job DDOC/builds #78 succeeded .
See Console Output and Coverage Report for more details.

added 1 commit

• 121d7ab0 - Fix the edit link for API documentation

Compare with previous version

I'm surprised that there's still no spaceless filter for jinja2 and we need to resort to hax :-)

approved this merge request

Ah, maybe worth adding a comment to explain what's happening?

Indeed. I just added a comment.

resolved all threads

Jenkins job DDOC/builds #80 succeeded .
See Console Output and Coverage Report for more details.

added 1 commit

• af594297 - Fix the edit link for API documentation

Compare with previous version

Jenkins job DDOC/builds #81 succeeded .
See Console Output and Coverage Report for more details.

Jenkins job DDOC/builds #82 succeeded .
See Console Output and Coverage Report for more details.

merged