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’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

Merged
merged 1 commit into from
Aug 20, 2024

Conversation

AetherUnbound
Copy link
Collaborator

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):

  1. ov just documentation/live
  2. ov pnpm exec prettier documentation/_serve/catalog/reference/DAGs.html

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • I ran the DAG documentation generator (ov just catalog/generate-docs for catalog
    PRs) 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
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@AetherUnbound AetherUnbound requested review from a team as code owners August 15, 2024 22:40
@AetherUnbound AetherUnbound requested review from krysal, dhruvkb and stacimc and removed request for a team August 15, 2024 22:40
@openverse-bot openverse-bot added 🧱 stack: catalog Related to the catalog and Airflow DAGs 🧱 stack: documentation Related to Sphinx documentation 🟩 priority: low Low priority and doesn't need to be rushed 🛠 goal: fix Bug fix 📄 aspect: text Concerns the textual material in the repository labels Aug 15, 2024
Copy link

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 🔄:

Copy link
Member

@krysal krysal left a 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?

@stacimc
Copy link
Contributor

stacimc commented Aug 19, 2024

I'm experiencing the same issue as @krysal 🤔

@AetherUnbound
Copy link
Collaborator Author

Hmm, could it be an issue on OSX? @dhruvkb @obulat @zackkrida are you all able to confirm?

@zackkrida
Copy link
Member

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

@AetherUnbound
Copy link
Collaborator Author

AetherUnbound commented Aug 20, 2024

Ahhh okay, y'all may need to run ov just documentation/install first 😄 that fixed it for me! I'll see what we can change in the ov flow to remove this problem.

@AetherUnbound AetherUnbound merged commit 7ba1381 into main Aug 20, 2024
71 of 75 checks passed
@AetherUnbound AetherUnbound deleted the docs/airflow-logs-parsing branch August 20, 2024 16:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 aspect: text Concerns the textual material in the repository 🛠 goal: fix Bug fix 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: catalog Related to the catalog and Airflow DAGs 🧱 stack: documentation Related to Sphinx documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

airflow_log_cleanup_workflow module docs are invalid markdown
6 participants