-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[docs] include sphinx objects.inv in
yarn build-api-docs
(#27906)
## Summary & Motivation Consolidate `yarn build-sphinx-objects-inv` and `yarn sync-api-docs` into a single `yarn build-api-docs`. ## How I Tested These Changes ## Changelog NOCHANGELOG
- Loading branch information
Showing
8 changed files
with
46 additions
and
637 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
#!/bin/bash | ||
# | ||
# Builds and synchronizes mdx API docs, and objects.inv using Sphinx | ||
# | ||
# USAGE | ||
# | ||
# yarn build-api-docs | ||
# | ||
|
||
set -e | ||
|
||
# Vercel-specific commands and configurations | ||
if ! [[ "$OSTYPE" =~ "darwin"* ]]; then | ||
echo "Detected non-Darwin host. Running Vercel-specific commands and configurations" | ||
|
||
# Required to resolve `locale.Error: unsupported locale setting` | ||
export LC_ALL=C.UTF-8 | ||
|
||
if ! command -v uv &> /dev/null; then | ||
curl -LsSf https://astral.sh/uv/install.sh | sh | ||
|
||
# shellcheck source=/dev/null | ||
source "$HOME/.local/bin/env" | ||
fi | ||
|
||
uv python install 3.11 | ||
uv venv | ||
source .venv/bin/activate | ||
uv pip install tox | ||
fi | ||
|
||
echo "Running sphinx-mdx and copying files to \`docs/api/python-api\`" | ||
tox -e sphinx-mdx | ||
cp -rf sphinx/_build/mdx/sections/api/apidocs/* docs/api/python-api/ | ||
|
||
echo "Running sphinx and copying \`object.inv\` to \`static/\`" | ||
tox -e sphinx | ||
cp sphinx/_build/json/objects.inv static/. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Binary file not shown.
f559cf6
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.
Deploy preview for dagster-docs ready!
✅ Preview
https://dagster-docs-jyvnqiv2c-elementl.vercel.app
Built with commit f559cf6.
This pull request is being automatically deployed with vercel-action