From: Hannes Duerr <h.duerr@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox-backup 1/2] docs: move custom.js and custom.css into _static folder
Date: Fri, 29 Mar 2024 16:07:36 +0100 [thread overview]
Message-ID: <20240329150737.243408-1-h.duerr@proxmox.com> (raw)
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@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
next reply other threads:[~2024-03-29 15:07 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-29 15:07 Hannes Duerr [this message]
2024-03-29 15:07 ` [pbs-devel] [PATCH proxmox-backup 2/2] docs: add missing html_css_files entry Hannes Duerr
2024-04-18 12:33 ` [pbs-devel] applied-series: [PATCH proxmox-backup 1/2] docs: move custom.js and custom.css into _static folder Fabian Grünbichler
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240329150737.243408-1-h.duerr@proxmox.com \
--to=h.duerr@proxmox.com \
--cc=pbs-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox