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

Docs update to reflect sphinx progress on #34 #142

Closed linusmarco closed 6 months ago

linusmarco commented 7 months ago

It appears that the underlying issue in sphinx causing #34 (live reloading not working for autodoc'd code files and other static files) is at partially fixed. I get automatic rebuilds and browser reloads when I update my code files (as long as the directory they're in is watched). Still no reloads for other static files, but the code files were the biggest pain point since that's where most of the docs live for many of us using autodoc.

This PR updates the README "sphinx bugs" section accordingly. I also fixed a dead link to the EBP contributing guide.

welcome[bot] commented 7 months ago

Thanks for submitting your first pull request! You are awesome! :hugs:
If you haven't done so already, check out EBP's Code of Conduct and our Contributing Guide, as this will greatly help the review process.
Welcome to the EBP community! :tada:

linusmarco commented 7 months ago

@pradyunsg Do you need me to do anything else before you merge this?

welcome[bot] commented 6 months ago

Congrats on your first merged pull request in this project! :tada: congrats
Thank you for contributing, we are very proud of you! :heart: