Skip to content
GitLab
Projects Groups Topics Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • E Eventutilities Python
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributor statistics
    • Graph
    • Compare revisions
  • Custom issue tracker
    • Custom issue tracker
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Artifacts
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Terraform modules
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Activity
  • Graph
  • Jobs
  • Commits
Collapse sidebar
  • repos
  • data-engineeringdata-engineering
  • Eventutilities Python
  • Merge requests
  • !67

Publish HTML docs to doc.wikimedia.org

  • Review changes

  • Download
  • Patches
  • Plain diff
Merged Gmodena requested to merge T337475-publish-docs into main Jun 06, 2023
  • Overview 2
  • Commits 23
  • Pipelines 7
  • Changes 10

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 Jun 07, 2023 by Gmodena
Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: T337475-publish-docs