[GSOC] Project 7 Tracking Issue: Automate docs generation for Training-operator Python SDK

[shivas1516]

Objective

Automate the generation of Training-operator Python SDK documentation and render it on kubeflow.org.

Tasks

• Proposal Submission: Submit GSoC project proposal as project proposal in Training-operator.
• Review Existing Documentation: Analyze documentation from other projects for best practices.
• Local Training-operator Setup: Clone Training-operator repository for kickoff project development.
• Evaluate Documentation Tools: Compare Sphinx, MkDocs, Jupyter Book, etc., to choose the best tool for the training operator's needs.
• Configure and Test Documentation Tool: Set up Sphinx (or chosen tool) for the training operator. Ensure quality and readability of generated documentation.
• Integrate with Kubeflow Website Repo: Make the Training-operator repository a submodule of the website repository and test documentation sharing.
• Automate Documentation Updates:
  • Write a GitHub Action to automate documentation updates and trigger documentation sharing to the website repository.
  • Script to handle events and update website files.

Expected Outcomes

• Fully automated, high-quality documentation process.
• Up-to-date documentation on the Training-operator website.

[shivas1516]

/area gsoc
/assign