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

Docs: Make previewing in development easier #364

Open
JacobCoffee opened this issue Jul 2, 2024 · 2 comments · May be fixed by #442
Open

Docs: Make previewing in development easier #364

JacobCoffee opened this issue Jul 2, 2024 · 2 comments · May be fixed by #442
Assignees
@JacobCoffee
Labels
Documentation Relates to the psf.infra.io documentation

Comments

@JacobCoffee
Copy link
Member

When needing to work on docs, I find the following a little cumbersome

psf-salt$ cd docs
psf-salt/docs$ make html && python -m http.server

It would be nice to have

  • hot-reloading (sphinx-autobuild?)
  • A Makefile target in the root of the repo so that we could just run make docs-serve or something to only need a oneshot command to get going
@JacobCoffee JacobCoffee added the Documentation Relates to the psf.infra.io documentation label Jul 2, 2024
@JacobCoffee JacobCoffee self-assigned this Jul 2, 2024
@ewdurbin
Copy link
Member

ewdurbin commented Jul 2, 2024

I agree that some online option would be a benefit.

As a note, docs can be built with the tox target tox -e docs

@hugovk
Copy link
Member

hugovk commented Jul 2, 2024

sphinx-autobuild is very handy, we have a make htmllive using it for the devguide, CPython docs and PEPs repos. For example:

https://github.com/python/devguide/blob/main/Makefile

@JacobCoffee JacobCoffee linked a pull request Aug 2, 2024 that will close this issue
Open
JacobCoffee added a commit that referenced this issue Aug 6, 2024
@JacobCoffee
Merge branch 'main' into #364-docs-previews
3d875db
JacobCoffee added a commit that referenced this issue Aug 9, 2024
@JacobCoffee
Merge branch 'main' into #364-docs-previews
89de35d
JacobCoffee added a commit that referenced this issue Aug 16, 2024
@JacobCoffee
Merge branch 'main' into #364-docs-previews
d649d94
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JacobCoffee JacobCoffee

Labels
Documentation Relates to the psf.infra.io documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(docs): add autobuild and serving for docs python/psf-salt
3 participants
@ewdurbin @hugovk @JacobCoffee