Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Add API reference docs #71

Merged
merged 12 commits into from
Apr 30, 2024
Merged

docs: Add API reference docs #71

merged 12 commits into from
Apr 30, 2024

Conversation

duwenxin99
Copy link
Contributor

  1. Set up API reference documents
  2. Update github workflow to test for documentation correctness with nox
  3. Add change log, html template, and convert README file from .md to .rst
  4. Add requirements.txt in docker/docs

@duwenxin99 duwenxin99 requested review from a team as code owners April 30, 2024 03:20
@conventional-commit-lint-gcf Conventional Commit Lint GCF
Copy link

conventional-commit-lint-gcf bot commented Apr 30, 2024 •
edited
Loading

🤖 I detect that the PR title and the commit message differ and there's only one commit. To use the PR title for the commit history, you can use Github's automerge feature with squashing, or use automerge label. Good luck human!

-- conventional-commit-lint bot
https://conventionalcommits.org/

@product-auto-label product-auto-label bot added the api: cloudsql-mysql Issues related to the googleapis/langchain-google-cloud-sql-mysql-python API. label Apr 30, 2024
averikitsch
averikitsch requested changes Apr 30, 2024
View reviewed changes
pyproject.toml
@@ -45,6 +57,11 @@ profile = "black"
python_version = "3.8"
warn_unused_configs = true

exclude = [
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Move under mypy overrides

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My comment was incorrect. This should stay under tool.mypy

src/langchain_google_cloud_sql_mysql/engine.py Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
@duwenxin99 duwenxin99 requested a review from averikitsch April 30, 2024 17:38
averikitsch
averikitsch reviewed Apr 30, 2024
View reviewed changes
Copy link
Collaborator

@averikitsch averikitsch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

readme = "README.md" ==> readme = "README.rst" in pyproject.toml

@averikitsch averikitsch changed the title doc: Add API reference docs docs: Add API reference docs Apr 30, 2024
@duwenxin99 duwenxin99 merged commit 7b39d29 into main Apr 30, 2024
13 checks passed
@duwenxin99 duwenxin99 deleted the doc branch April 30, 2024 22:36
@release-please release-please bot mentioned this pull request Apr 30, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@averikitsch averikitsch averikitsch approved these changes

Assignees
No one assigned
Labels
api: cloudsql-mysql Issues related to the googleapis/langchain-google-cloud-sql-mysql-python API.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@duwenxin99 @averikitsch