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

Docs CI fix #109

Merged
merged 2 commits into from
Mar 11, 2025
Merged

Docs CI fix #109

merged 2 commits into from
Mar 11, 2025

Conversation

lindsay-stevens
Copy link
Contributor

@lindsay-stevens lindsay-stevens commented Mar 10, 2025

Fixes CI docs build job failure at mkdocs build --strict step, which blocks the automated tests job in GitHub actions file verify.yml (example Actions run). Probably would block publishing in release.yml as well.

What has been done to verify that this works as intended?

  • CI docs build job passed
  • local docs build passed
  • checked each page in local docs build vs. current published version
  • pages look the same and nothing obviously weird looking (desktop view size, Firefox v136).

Why is this the best possible solution? Were any other approaches considered?

Initially I just kicked the can down the road by adding a dependency for mkdocs-autorefs. But I thought I'd see if the most recent docs deps versions were compatible with Python 3.12 and each other, and it seems they are. If it had required changing configs (mkdocs.yml) or content changes (especially the notebooks) then I probably would have left it alone for now instead.

How does this change affect users? Describe intentional changes to behavior and behavior that could have accidentally been affected by code changes. In other words, what are the regression risks?

Fixes CI but otherwise docs unchanged.

Do we need any specific form for testing your changes? If so, please attach one.

N/A

Does this change require updates to documentation? If so, please file an issue here and include the link below.

N/A

Before submitting this PR, please make sure you have:

  • included test cases for core behavior and edge cases in tests
  • run python -m unittest and verified all tests pass
  • run ruff format pyodk tests and ruff check pyodk tests to lint code
  • verified that any code or assets from external sources are properly credited in comments

- removed griffe and autorefs since these were added only to
  work around transitive dependency incompatibilities.
@lognaturel lognaturel merged commit 62d87cb into getodk:master Mar 11, 2025
14 checks passed
@lindsay-stevens lindsay-stevens deleted the docs-fixes branch March 11, 2025 05:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants