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

Add sphinx-autobuild to documentation build options #1244

Closed
DON-BRAN opened this issue Nov 2, 2022 · 4 comments
Closed

Add sphinx-autobuild to documentation build options #1244

DON-BRAN opened this issue Nov 2, 2022 · 4 comments
Labels
good-first-issue Good place to get started as a new contributor.

Comments

@DON-BRAN
Copy link
Contributor

DON-BRAN commented Nov 2, 2022

I believe it will be great to have sphinx-autobuild added as a build option for the documentation. This can help avoid constant manual builds during development.

What are your thoughts please? 🤓

@joshmoore
Copy link
Member

Are you suggesting adding an optional requirement? Strictly speaking, anyone could already install the package and use it locally now, right?

@DON-BRAN
Copy link
Contributor Author

DON-BRAN commented Nov 4, 2022

Are you suggesting adding an optional requirement? Strictly speaking, anyone could already install the package and use it locally now, right?

Yes that's right anyone can install the package and use locally. Was just wondering if it could be shipped in the documentation build script to reduce the setup complexity for others

@joshmoore
Copy link
Member

Guess I don't know exactly what that would look like, but happy to consider it.

@jhamman jhamman added the good-first-issue Good place to get started as a new contributor. label Dec 7, 2023
@jhamman
Copy link
Member

jhamman commented Jan 10, 2025

This works today using hatch:

hatch --env docs run serve

@jhamman jhamman closed this as completed Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good-first-issue Good place to get started as a new contributor.
Projects
None yet
Development

No branches or pull requests

3 participants