[pbs-devel] applied-series: [PATCH proxmox-backup 1/2] docs: move custom.js and custom.css into _static folder

[Fabian Grünbichler]

seems sensible, no change in output other than the css being picked up
in more places now.

On March 29, 2024 4:07 pm, Hannes Duerr wrote:
> The sphinx documentation [0] describes the _static folder as the
> location for the custom.js and custom.css so we move the files there, as
> we do not need those files outside the directory.
> This also removes the error message when building:
> WARNING: html_static_path entry '_static' does not exist
> 
> [0] https://www.sphinx-doc.org/en/master/development/theming.html#add-your-own-static-files-to-the-build-assets
> 
> Signed-off-by: Hannes Duerr <h.duerr at proxmox.com>
> ---
> 
> if there is a still a reason why we keep them outside which i could not
> come up with, please let me know
> 
>  docs/Makefile                 | 4 ++--
>  docs/{ => _static}/custom.css | 0
>  docs/{ => _static}/custom.js  | 0
>  3 files changed, 2 insertions(+), 2 deletions(-)
>  rename docs/{ => _static}/custom.css (100%)
>  rename docs/{ => _static}/custom.js (100%)
> 
> diff --git a/docs/Makefile b/docs/Makefile
> index 0d0963f3..b2d863cd 100644
> --- a/docs/Makefile
> +++ b/docs/Makefile
> @@ -138,9 +138,9 @@ lto-barcode/lto-barcode-generator.js: ${LTO_BARCODE_JS_SOURCE}
>  	mv $@.tmp $@
>  
>  .PHONY: html
> -html: ${GENERATED_SYNOPSIS} images/proxmox-logo.svg custom.css conf.py ${PRUNE_SIMULATOR_FILES} ${LTO_BARCODE_FILES} ${API_VIEWER_SOURCES}
> +html: ${GENERATED_SYNOPSIS} images/proxmox-logo.svg _static/custom.css conf.py ${PRUNE_SIMULATOR_FILES} ${LTO_BARCODE_FILES} ${API_VIEWER_SOURCES}
>  	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
> -	install -m 0644 custom.js custom.css images/proxmox-logo.svg $(BUILDDIR)/html/_static/
> +	install -m 0644 _static/custom.js _static/custom.css images/proxmox-logo.svg $(BUILDDIR)/html/_static/
>  	install -dm 0755 $(BUILDDIR)/html/prune-simulator
>  	install -m 0644 ${PRUNE_SIMULATOR_FILES} $(BUILDDIR)/html/prune-simulator
>  	install -dm 0755 $(BUILDDIR)/html/lto-barcode
> diff --git a/docs/custom.css b/docs/_static/custom.css
> similarity index 100%
> rename from docs/custom.css
> rename to docs/_static/custom.css
> diff --git a/docs/custom.js b/docs/_static/custom.js
> similarity index 100%
> rename from docs/custom.js
> rename to docs/_static/custom.js
> -- 
> 2.39.2
> 
> 
> 
> _______________________________________________
> pbs-devel mailing list
> pbs-devel at lists.proxmox.com
> https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel
> 
> 
>