Skip to content

Docs: Make previewing in development easier  #364

Open

Description

@JacobCoffee

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

Activity

  1. self-assigned this
    on Jul 2, 2024
  2. ewdurbin commented on Jul 2, 2024

    @ewdurbin
    Member

    I agree that some online option would be a benefit.

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

  3. hugovk commented on Jul 2, 2024

    @hugovk
    Member

    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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

DocumentationRelates to the psf.infra.io documentation

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions