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 scripts to build the documentation #79

Open
jtpio opened this issue Feb 23, 2024 · 0 comments
Open

Add scripts to build the documentation #79

jtpio opened this issue Feb 23, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@jtpio
Copy link
Member

jtpio commented Feb 23, 2024

Problem

Currently there is no easy way to build the documentation locally.

Suggested Improvement

  • Add scripts to build the documentation. For example similar to:

https://github.com/voila-dashboards/voila/blob/5aa861dc153215c66d8ccdff040f4ac868d7af3a/pyproject.toml#L145-L151

[tool.hatch.envs.docs]
features = ["docs"]

[tool.hatch.envs.docs.scripts]
build = "sphinx-build -W -b html docs docs/build/html"
watch = "sphinx-autobuild -W -b html docs docs/build/html --host 0.0.0.0"
serve = "python -m http.server --directory docs/build/html"
  • Add a section to the contributing guide about contributing to the documentation
@jtpio jtpio added the documentation Improvements or additions to documentation label Feb 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant