[Refactor] Migrate dependencies in docs/requirements.txt to pyproject.toml #325
Conversation
|
@d33bs Is there a way to test the docs build process for this pull request? I'm not sure where to look for that. |
Codecov Report
@@ Coverage Diff @@
## main #325 +/- ##
==========================================
+ Coverage 95.40% 95.62% +0.22%
==========================================
Files 56 56
Lines 3134 3134
==========================================
+ Hits 2990 2997 +7
+ Misses 144 137 -7
Flags with carried forward coverage won't be shown. Click here to find out more. see 3 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
|
Hi @kenibrewer, previously I created a standalone Read the Docs deployment for testing via a fork here: https://readthedocs.org/dashboard/pycytominer-test-docs . I'd be glad to invite you to administrate this and use for testing if you'd like. Generally, I'd propose we move into a formalized testing process for documentation to cover scenarios like this one and others as they come up. Would you have any thoughts on the approach here? |
|
@d33bs I think we should configure the Pull Requests features for Read the Docs here described here. That should allow us to use just one ReadTheDocs deployment instead of two. With that PR setting turned on, we should be able to use the Github action here, to attach previews to any PR that affects docs. |
There was a problem hiding this comment.
Great stuff with this PR, thank you for sending this through! I left a minor comment about naming for Github Actions, otherwise I think things are looking good.
Regarding your previous thoughts about the approach, I love the idea! Would you be interested in helping to enable the functionality on Readthedocs via the proper access there? Please let me know and I'll add you so you may configure things appropriately. If not, I can help out with the adjustments which are needed.
Either way, once we enable the functionality, do we need to do anything special to see the results in this PR?
Sure! I'd be happy to figure that integration on ReadTheDocs. I think there might be an additional solution I might be able to enable if I'm a maintainer for both the Read The Docs project and Github using the ReadTheDocs Github app. That option should show the actual ReadTheDocs build process along with all the other pipelines defined with Github Actions.
As currently set up, the workflow only runs when the pull request is created which is what is suggested in the ReadTheDocs Action documentation. I tried enabling it to run on any pull request event, but I interpreted "Resource Not Available" error to mean that the event is designed only to run on PR creation because that's when it has permissions to edit the PR description. One corner case I'm aware of, is that if someone creates a PR without docs changes and then adds them later, this preview pipeline will never run. We could enable the pipeline to run on all PRs instead by getting rid of the paths filter. In the end though, the docs preview pipeline is a (useful) convenience function that will help contributors know where they can preview any changes they make to the docs. I think the full ReadTheDocs Github App integration is the workflow that will prevent us from merging any changes that break the docs build process. |
Description
This migrates the dependencies for the docs build process into the pyproject.toml file to unify all dependency installs using Poetry. It also adds a docs preview pipeline that adds a preview link to any newly created PRs.
Fixes #321
What is the nature of your change?
Checklist
Please ensure that all boxes are checked before indicating that a pull request is ready for review.