Skip to content

docs: Add API reference documentation and improve doc build#79

Merged
averikitsch merged 1 commit intomainfrom
api-ref-docs
Feb 18, 2025
Merged

docs: Add API reference documentation and improve doc build#79
averikitsch merged 1 commit intomainfrom
api-ref-docs

Conversation

@vishwarajanand
Copy link
Copy Markdown
Contributor

Adds API reference documentation generated from docstrings and improves the documentation build process.

Changes include:

  • API Reference Docs: Generated API reference documentation for the following modules: engine, vectorstore, loader, and history. This makes it easier for users to understand and use the library's classes and methods.
  • Documentation Testing: Integrated documentation testing into the CI workflow using Nox. This ensures that documentation builds successfully and catches any issues early.
  • HTML Templates & Symlinks: Added HTML templates and symlinks for the README and changelog to streamline the documentation build.
  • Fixed Doc Build Warnings: Resolved warnings related to the README, engine and document_store that were appearing in the docfx build log. This improves the overall quality and reliability of the documentation build.

b/367372730

@product-auto-label product-auto-label Bot added the api: cloudsql-postgres Issues related to the googleapis/llama-index-cloud-sql-pg-python API. label Feb 15, 2025
@vishwarajanand vishwarajanand changed the title docs: Add API reference docs docs: Add API reference documentation and improve doc build Feb 17, 2025
@vishwarajanand vishwarajanand marked this pull request as ready for review February 18, 2025 19:36
@vishwarajanand vishwarajanand requested review from a team February 18, 2025 19:36
@averikitsch averikitsch merged commit 985fb17 into main Feb 18, 2025
@averikitsch averikitsch deleted the api-ref-docs branch February 18, 2025 22:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api: cloudsql-postgres Issues related to the googleapis/llama-index-cloud-sql-pg-python API.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants