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

Move docs dependencies into their own group #1053

Closed
briantist opened this issue Sep 10, 2023 · 0 comments · Fixed by #1119
Closed

Move docs dependencies into their own group #1053

briantist opened this issue Sep 10, 2023 · 0 comments · Fixed by #1119
Labels
dependencies Pull requests that update a dependency file developer experience Developer setup and experience documentation documentation updates and/or requests for expanded documentation

Comments

@briantist
Copy link
Contributor

briantist commented Sep 10, 2023

Now that we have poetry groups set up, with optional dev dependencies in their own group, I think we can further split off docs dependencies into their own group.

The reasons I want to do this:

  • encourage more documentation contributions and make it easier for minimal testing of them locally
  • to clarify dependencies for readthedocs (RTD)
  • to aid in dependency installation for first draft PR docs build workflow #1042
  • to give an option not to install these for folks who only want to run pytest locally
  • make maintenance of these dependencies easier when we know they don't conflict with other dev dependencies
  • to clarify dependencies around doctest

That last point is where I think we're going to hit some snags. Doctest is used to test code examples in the documentation, and we've done some weird things with it. It's a little hard to pick apart right now, and I think that stuff needs maintenance. It would be helpful for us to figure out what the future is for doctest, whether we want to lean into it and shore it up, or remove it (and its dependencies).

@briantist briantist added documentation documentation updates and/or requests for expanded documentation dependencies Pull requests that update a dependency file developer experience Developer setup and experience labels Sep 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file developer experience Developer setup and experience documentation documentation updates and/or requests for expanded documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant