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.

Sign up for GitHub

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

Jump to bottom

ci/docs: updates related to building and testing documentation #500

Merged
merged 6 commits into from
Mar 25, 2022
Merged

ci/docs: updates related to building and testing documentation #500

merged 6 commits into from
Mar 25, 2022

Conversation

consideRatio
Copy link
Collaborator

@consideRatio consideRatio commented Mar 25, 2022 •
edited
Loading

This PR is about the documentation: improving developer experience, build and test automation, and fixes misc broken links etc.

  • make linkcheck and make devenv is now available.
    • linkcheck checks for broken links
    • devenv starts a browser to view the built documentation, and rebuilds and refreshes the browser when documentation changes
  • A github workflow job is added to run make linkcheck
  • The github workflow building documentation is now stricter, failing on warnings. Note that we had a warning where we didn't have sqlalchemy as a dependency, which made the autodoc-traits fail to provide a configuration reference when inspecting all the .py files.
  • Fixes various broken links and updates link that were redirecting, as found by linkcheck

@consideRatio consideRatio changed the title ci/docs: add linkcheck/devenv to Makefile, fix broken links, run linkcheck in ci ci/docs: add linkcheck/devenv to Makefile, fix broken links, run linkcheck in ci, use autodoc-traits package, make doc build stricter and fix missing dependencies Mar 25, 2022
@consideRatio consideRatio changed the title ci/docs: add linkcheck/devenv to Makefile, fix broken links, run linkcheck in ci, use autodoc-traits package, make doc build stricter and fix missing dependencies ci/docs: updates related to building and testing documentation Mar 25, 2022
@jacobtomlinson jacobtomlinson merged commit 1c6d909 into dask:main Mar 25, 2022
This was referenced Mar 25, 2022
Merged
Closed
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jacobtomlinson jacobtomlinson Awaiting requested review from jacobtomlinson

Assignees
No one assigned
Labels
ci documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@consideRatio @jacobtomlinson