Release to Prod [2.8.20]

[johnwalz97]

Internal Notes for Reviewers

External Release Notes

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
5 out of 6 committers have signed the CLA.

✅ AnilSorathiya
✅ validbeck
✅ johnwalz97
✅ juanmleng
✅ cachafla
❌ nrichers
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[github-actions]

PR Summary

This pull request enhances the documentation generation process by integrating Quarto for generating API documentation. The changes include:

1. GitHub Actions Workflow Updates:

   • Updated .github/workflows/integration.yaml and .github/workflows/python.yaml to ignore all paths under docs/ instead of just docs/_build/.
   • Added a new step in the python.yaml workflow to generate Quarto documentation using the make quarto-docs command.

2. New Quarto Documentation Workflow:

   • Introduced a new workflow file .github/workflows/quarto-docs.yaml to automate the generation of Quarto documentation using Griffe for API extraction and Jinja2 templates.

3. Makefile Enhancements:

   • Added a new target quarto-docs in the Makefile to handle the generation of Quarto documentation.
   • The quarto-docs target includes steps to clean old files, generate an API JSON dump, and create Quarto documentation from templates.

4. Documentation Directory:

   • Added a new docs/README.md file explaining the process of generating Quarto Markdown for the Python API.
   • The docs/ directory now includes templates, macros, CSS, and Quarto Markdown output for generating the ValidMind Library reference documentation.

5. .gitignore Updates:

   • Updated .gitignore to include docs/validmind.json for Quarto docs.

6. README Updates:

   • Updated links in README.md and README.pypi.md to point to the new documentation paths.

7. Removal of Old Documentation:

   • Removed old HTML documentation files from docs/_build/.

These changes aim to streamline the documentation process, making it more efficient and maintainable by leveraging Quarto's capabilities.

Test Suggestions

• Verify that the Quarto documentation is generated correctly by running make quarto-docs locally.
• Ensure that the GitHub Actions workflows execute successfully and generate the expected documentation artifacts.
• Check that the generated Quarto documentation is correctly integrated into the documentation site.
• Test the new Quarto documentation generation process with different branches and ensure it ignores the specified paths.
• Validate that the .gitignore updates prevent unnecessary files from being tracked.

[johnwalz97]

lgtm!

@cachafla @AnilSorathiya @juanmleng can you take a look and see if this looks good

[cachafla]

Nice 👌

[cachafla]

BTW, next time remember you can use the Create Prod Release action that automates this :P

[johnwalz97]

BTW, next time remember you can use the Create Prod Release action that automates this :P

Ah okay... I always forget about that 😬. Will do