-
Notifications
You must be signed in to change notification settings - Fork 13.6k
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
Conversation
The latest updates on your projects. Learn more about Vercel for Git 鈫楋笌 1 Ignored Deployment
|
There was a problem hiding this 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
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 |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
.github/workflows/api_doc_build.yml
Outdated
on: | ||
push: | ||
- branches: | ||
- 'bagatur/api_docs_build_gha' |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
its not ignored
No description provided.