From 0ef24c26b14bc35ceda574ff27bb9f3aaaf06027 Mon Sep 17 00:00:00 2001 From: Jirka Date: Sat, 27 Apr 2024 21:50:30 +0200 Subject: [PATCH 1/5] docs: try autobuild for local dev --- Makefile | 6 +++++- docs/Makefile | 3 +++ requirements/_docs.txt | 1 + 3 files changed, 9 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index ebe2503ca4b..512cd0d99e8 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,4 @@ -.PHONY: clean test get-sphinx-template docs env data +.PHONY: clean test get-sphinx-template docs live-docs env data export FREEZE_REQUIREMENTS=1 # assume you have installed need packages @@ -38,6 +38,10 @@ docs: clean get-sphinx-template # apt-get install -y texlive-latex-extra dvipng texlive-pictures texlive-fonts-recommended cm-super cd docs && make html --debug --jobs $(nproc) SPHINXOPTS="-W --keep-going" +live-docs: get-sphinx-template + pip install -e . --quiet -r requirements/_docs.txt + cd docs && make livehtml + env: pip install -e . -U -r requirements/_devel.txt diff --git a/docs/Makefile b/docs/Makefile index 35e5650808f..cd9feeea2b1 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -17,3 +17,6 @@ help: # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +livehtml: + sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/requirements/_docs.txt b/requirements/_docs.txt index ea8bbcd7978..638580ec7a9 100644 --- a/requirements/_docs.txt +++ b/requirements/_docs.txt @@ -10,6 +10,7 @@ sphinx-autodoc-typehints ==1.23.0 sphinx-paramlinks ==0.6.0 sphinx-togglebutton ==0.3.2 sphinx-copybutton ==0.5.2 +sphinx-autobuild ==2024.04.16 lightning >=1.8.0, <2.3.0 lightning-utilities ==0.11.2 From a18710a4689ecea516ac427b16d439c5049bad84 Mon Sep 17 00:00:00 2001 From: Jirka Date: Mon, 6 May 2024 23:41:11 +0200 Subject: [PATCH 2/5] make --- docs/Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Makefile b/docs/Makefile index cd9feeea2b1..bae43786043 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -19,4 +19,4 @@ help: @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) livehtml: - sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) From a8319305a2bc5d2cf596e9a5184f8048440bce8e Mon Sep 17 00:00:00 2001 From: Jirka Date: Wed, 15 May 2024 22:09:32 +0200 Subject: [PATCH 3/5] with source --- requirements/_docs.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements/_docs.txt b/requirements/_docs.txt index 48b8938c644..e16d8f8417b 100644 --- a/requirements/_docs.txt +++ b/requirements/_docs.txt @@ -9,7 +9,7 @@ sphinx-autodoc-typehints ==1.23.0 sphinx-paramlinks ==0.6.0 sphinx-togglebutton ==0.3.2 sphinx-copybutton ==0.5.2 -sphinx-autobuild ==2024.04.16 +sphinx-autobuild @ https://github.com/sphinx-doc/sphinx-autobuild/archive/refs/heads/main.zip # or >2024.04.16 with fixed https://github.com/sphinx-doc/sphinx-autobuild/pull/157 sphinx-gallery ==0.16.0 lightning >=1.8.0, <2.3.0 From 7ec559c320c54c57a60d019f58af954a73420182 Mon Sep 17 00:00:00 2001 From: Jirka B Date: Thu, 3 Oct 2024 20:00:14 +0200 Subject: [PATCH 4/5] ex --- Makefile | 1 + 1 file changed, 1 insertion(+) diff --git a/Makefile b/Makefile index 8288958cfd3..360f76d9c0b 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,6 @@ .PHONY: clean test get-sphinx-template docs live-docs env data +export TOKENIZERS_PARALLELISM=false export FREEZE_REQUIREMENTS=1 # assume you have installed need packages export SPHINX_MOCK_REQUIREMENTS=1 From b328c19524c6621eabbdeb738bbb3016ed34f4cd Mon Sep 17 00:00:00 2001 From: jirka Date: Thu, 3 Oct 2024 20:11:43 +0200 Subject: [PATCH 5/5] jobs --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 360f76d9c0b..7ab37aab29d 100644 --- a/Makefile +++ b/Makefile @@ -42,7 +42,7 @@ docs: clean get-sphinx-template live-docs: get-sphinx-template pip install -e . --quiet -r requirements/_docs.txt - cd docs && make livehtml + cd docs && make livehtml --jobs $(nproc) env: pip install -e . -U -r requirements/_devel.txt