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

feat: add sphinx autobuild #24

Merged
merged 1 commit into from
Oct 24, 2024
Merged

Conversation

SamJUK
Copy link
Contributor

@SamJUK SamJUK commented Oct 21, 2024

This PR proposes to install the Sphinx Autobuild package to simplify local development of the docs. Some key features it provides are:

  • Built-in Web Server
  • Hot Reloading on source file change

With this, the proposed local build steps would be

git clone https://github.com/wardenenv/docs.git warden-docs && cd warden-docs
pip install -r requirements.txt
make watch

@navarr navarr merged commit d4f6d54 into wardenenv:main Oct 24, 2024
1 check failed
@SamJUK
Copy link
Contributor Author

SamJUK commented Oct 25, 2024

Re the failing build. Upstream image (ammaraskar/sphinx-action@0.4) uses python:3-slim which received an update to 3.13 recently which is not compatible with current Sphinx version. Options I see are:

  1. Replace the GH action with a python container pinned to 3.12, and run the build steps manually.
  2. Update Sphinx & the GH Action to their latest builds.

More than happy to submit another Pr if your strapped for time.

@SamJUK SamJUK mentioned this pull request Nov 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants