search

sphinx-doc / sphinx-autobuild

Watch a Sphinx directory and rebuild the documentation when a change is detected. Also includes a hot-reload web server.
MIT License
523 stars 75 forks source link

Add watchfiles as dependency #152

Closed radiac closed 2 months ago

radiac commented 2 months ago

The watchfiles dependency used in server.py is missing from requirements.

Since the changes 5 days ago, with a clean install, you get the following error:

$ sphinx-autobuild
Traceback (most recent call last):
  File "/.../sphinx-autobuild", line 5, in <module>
    from sphinx_autobuild.__main__ import main
  File "/.../sphinx_autobuild/__main__.py", line 22, in <module>
    from sphinx_autobuild.server import RebuildServer
  File "/.../sphinx_autobuild/server.py", line 8, in <module>
    import watchfiles
ModuleNotFoundError: No module named 'watchfiles'

After installing watchfiles the project runs successfully. This PR adds the package as a dependency in pyproject.toml.

hugovk commented 2 months ago

@AA-Turner @pradyunsg Please could we have a bugfix release?

Otherwise we'll need to either pin to the old version or add watchfiles as a temporary dependency to CPython docs (plus backports) and the devguide and PEPs.

Thank you!

pradyunsg commented 2 months ago

@AA-Turner clicked the relevant buttons and made it happen. :)

hugovk commented 2 months ago

Confirmed working now, thanks all!