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
  • !62

Generate HTML pages from docstrings

  • Review changes

  • Download
  • Patches
  • Plain diff
Merged Gmodena requested to merge T336488-generate-doc into main Jun 02, 2023
  • Overview 3
  • Commits 24
  • Pipelines 23
  • Changes 13

This MR introduces HTML doc generation from doscstrinngs using pdoc3. For our specific project it looks easier to integrate than sphinx. I previously considered pydoctor, but it does not work particularly well with our docstring formatting choices (it assumes docstrings are epytext).

HTML files will be generated under docs/build by a newly introduced make-html-docs CI job. Under the hood this calls a make html-docs target that is available outside of CI too. This MR only takes care of generating the doc. Publishing requires integrating the job with https://gitlab.wikimedia.org/repos/releng/docpub.

This MR bumps the base openjdk CI image to openjdk-11-jdk:11.0.18-s0-20230604 (Debian Bullseye), that ships with Python 3.9. A version bump of Python was required to address compat issues with pydoc

cc @otto @tchin.

Bug: T336488

Bug: T337475

Edited Jun 05, 2023 by Gmodena
Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: T336488-generate-doc