-
Notifications
You must be signed in to change notification settings - Fork 197
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’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix DAG docstrings so they no longer produce improper HTML #4770
Conversation
Full-stack documentation: https://docs.openverse.org/_preview/4770 Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again. You can check the GitHub pages deployment action list to see the current status of the deployments. Changed files 🔄: |
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.
I couldn't build the documentation locally with the instructions, not even after doing a ./ov clean && ./ov init
. I got the following error:
INFO: The saved Python interpreter doesn't match the project's requirement. Trying to find another one.
WARNING: Project requires a python version of ==3.11.*, The virtualenv is being created for you as it cannot be matched to the right version.
INFO: python.use_venv is on, creating a virtualenv for this project...
Virtualenv is created successfully at /opt/pdm/venvs/documentation-QbEAfFES-3.11
[PdmUsageError]: Command 'sphinx-autobuild' is not found in your PATH.
error: Recipe `live` failed on line 72 with exit code 1
Did this happen to you at some point by any chance?
I'm experiencing the same issue as @krysal 🤔 |
Hmm, could it be an issue on OSX? @dhruvkb @obulat @zackkrida are you all able to confirm? |
Same issue on Fedora! > ov just documentation/live
rm -rf _serve/ _build
pdm run sphinx-autobuild -b html . _serve/ --port 50230
INFO: The saved Python interpreter doesn't match the project's requirement. Trying to find another one.
WARNING: Project requires a python version of ==3.11.*, The virtualenv is being created for you as it cannot be matched to the right version.
INFO: python.use_venv is on, creating a virtualenv for this project...
Virtualenv is created successfully at /opt/pdm/venvs/documentation-QrgCiFGL-3.11
[PdmUsageError]: Command 'sphinx-autobuild' is not found in your PATH.
error: Recipe `live` failed on line 72 with exit code 1 |
Ahhh okay, y'all may need to run |
Fixes
Fixes #4750 by @sarayourfriend
Description
This PR fixes a few instances of brackets within the DAG docstrings that would produce invalid HTML in the resulting document that gets rendered for the documentation site.
Testing Instructions
Run the following, and HTML should be output (without raising any errors):
ov just documentation/live
ov pnpm exec prettier documentation/_serve/catalog/reference/DAGs.html
Checklist
Update index.md
).main
) or a parent feature branch.ov just catalog/generate-docs
for catalogPRs) or the media properties generator (
ov just catalog/generate-docs media-props
for the catalog or
ov just api/generate-docs
for the API) where applicable.Developer Certificate of Origin
Developer Certificate of Origin