Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Auto hot reloading with sphinx-autobuild #584

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

Open
jbampton wants to merge 1 commit into apache:main
base: main
Choose a base branch
Loading
from jbampton:hot-reloading
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions Makefile
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,12 @@ BUILDDIR = build
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile
.PHONY: help Makefile livehtml

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

livehtml:
sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
8 changes: 8 additions & 0 deletions make.bat
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ set BUILDDIR=build
set SPHINXPROJ=ApacheCloudStack

if "%1" == "" goto help
REM --- Added section for 'livehtml' ---
if "%1" == "livehtml" goto livehtml
REM -------------------------------------

%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
Expand All @@ -29,6 +32,11 @@ rd %BUILDDIR% /q /s
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
goto end

:livehtml
REM
sphinx-autobuild "%SOURCEDIR%" "%BUILDDIR%" %SPHINXOPTS% %O%
goto end

:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%

Expand Down
1 change: 1 addition & 0 deletions requirements.txt
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ Sphinx==7.2.6
sphinx-rtd-theme==2.0.0
readthedocs-sphinx-ext==2.2.5
Jinja2==3.1.5
sphinx-autobuild==2025年8月25日

AltStyle によって変換されたページ (->オリジナル) /