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.

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

Already on GitHub? Sign in to your account

infra: add api docs build GHA #17493

Merged
merged 8 commits into from
Feb 14, 2024
Merged

infra: add api docs build GHA #17493

merged 8 commits into from
Feb 14, 2024

Conversation

baskaryan
Copy link
Collaborator

No description provided.

@dosubot dosubot bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Feb 13, 2024
Copy link

vercel bot commented Feb 13, 2024

The latest updates on your projects. Learn more about Vercel for Git 鈫楋笌

1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
langchain 猬滐笍 Ignored (Inspect) Visit Preview Feb 14, 2024 0:44am

@dosubot dosubot bot added the 馃:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder label Feb 13, 2024
Copy link
Member

@efriis efriis left a comment

Choose a reason for hiding this comment

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

nice!

.github/workflows/api_doc_build.yml Outdated Show resolved Hide resolved
Comment on lines 29 to 34
poetry run python -m pip install --upgrade --no-cache-dir pip setuptools
poetry run python -m pip install --upgrade --no-cache-dir sphinx readthedocs-sphinx-ext
poetry run python -m pip install ./libs/partners/*
poetry run python -m pip install --exists-action=w --no-cache-dir -r docs/api_reference/requirements.txt
poetry run python docs/api_reference/create_api_rst.py
poetry run python -m sphinx -T -E -b html -d _build/doctrees -c docs/api_reference docs/api_reference api_reference_build/html -j auto
Copy link
Member

Choose a reason for hiding this comment

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

now that we control it all can we just run the make command / make this a make command that makes it locally

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

make command needs to be updated to work here

on:
push:
- branches:
- 'bagatur/api_docs_build_gha'
Copy link
Member

Choose a reason for hiding this comment

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

this might create an infinite loop with the action at the end

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

its commiting to api_docs_build, this is api_docs_build_gha

poetry run python -m pip install ./libs/partners/*
poetry run python -m pip install --exists-action=w --no-cache-dir -r docs/api_reference/requirements.txt
poetry run python docs/api_reference/create_api_rst.py
poetry run python -m sphinx -T -E -b html -d _build/doctrees -c docs/api_reference docs/api_reference api_reference_build/html -j auto
Copy link
Member

Choose a reason for hiding this comment

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

do we need to update gitignore to get this path in this branch?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

its not ignored

@baskaryan baskaryan merged commit 54373fb into master Feb 14, 2024
76 checks passed
@baskaryan baskaryan deleted the bagatur/api_docs_build_gha branch February 14, 2024 00:46
snsten pushed a commit to snsten/langchain that referenced this pull request Feb 15, 2024
haydeniw pushed a commit to haydeniw/langchain that referenced this pull request Feb 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
馃:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder size:M This PR changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants