Skip to content

Publish HTML docs to doc.wikimedia.org

Gmodena requested to merge T337475-publish-docs into main

Re-opens !64 (merged)

The implementation in !64 (merged) (reverted) failed on main because publish_gitlab_release (needed by publish_html_docs) could not be found. I suspect some rules / imports in workflow_util templating came into play: on a default branch publish_gitlab_release would become available only after trigger_release is triggered.

With this MR docs will be published at https://doc.wikimedia.org/data-engineering/eventutilities-python when a new wheel is successfully uploaded to Gitlab's pypi registry ( publish_python_wheel is triggered at release). This behavior should ensure that wheel releases and documentation are in sync.

This MR replaces pydoc3 with sphinx to fix rendering issues with rst markdown in docstrings.

The change has been verified with Gitlab CI YAML validator.

Demo: https://doc.wikimedia.org/data-engineering/eventutilities-python/

Bug: T337475

cc / @otto @tchin

Edited by Gmodena

Merge request reports