From: Thomas Huth <thuth@redhat.com>
To: qemu-devel@nongnu.org, Peter Maydell <peter.maydell@linaro.org>
Cc: Alexander Bulekov <alxndr@bu.edu>, Cornelia Huck <cohuck@redhat.com>
Subject: [PULL 15/19] docs: add "page source" link to sphinx documentation
Date: Tue, 10 Nov 2020 12:11:28 +0100 [thread overview]
Message-ID: <20201110111132.559399-16-thuth@redhat.com> (raw)
In-Reply-To: <20201110111132.559399-1-thuth@redhat.com>
From: Daniel P. Berrangé <berrange@redhat.com>
Add a link to the top of the sidebar in every docs page that takes the
user back to the source code in gitlab.
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
Message-Id: <20201102130926.161183-5-berrange@redhat.com>
Signed-off-by: Thomas Huth <thuth@redhat.com>
---
docs/_templates/editpage.html | 5 +++++
docs/conf.py | 1 +
docs/devel/_templates/editpage.html | 5 +++++
docs/interop/_templates/editpage.html | 5 +++++
docs/specs/_templates/editpage.html | 5 +++++
docs/system/_templates/editpage.html | 5 +++++
docs/tools/_templates/editpage.html | 5 +++++
docs/user/_templates/editpage.html | 5 +++++
8 files changed, 36 insertions(+)
create mode 100644 docs/_templates/editpage.html
create mode 100644 docs/devel/_templates/editpage.html
create mode 100644 docs/interop/_templates/editpage.html
create mode 100644 docs/specs/_templates/editpage.html
create mode 100644 docs/system/_templates/editpage.html
create mode 100644 docs/tools/_templates/editpage.html
create mode 100644 docs/user/_templates/editpage.html
diff --git a/docs/_templates/editpage.html b/docs/_templates/editpage.html
new file mode 100644
index 0000000000..4319b0f5ac
--- /dev/null
+++ b/docs/_templates/editpage.html
@@ -0,0 +1,5 @@
+<div id="editpage">
+ <ul>
+ <li><a href="https://gitlab.com/qemu-project/qemu/-/blob/master/docs/{{pagename}}.rst">Page source</a></li>
+ </ul>
+</div>
diff --git a/docs/conf.py b/docs/conf.py
index e584f68393..d40d8ff37b 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -177,6 +177,7 @@ html_theme_options = {
html_sidebars = {
'**': [
'about.html',
+ 'editpage.html',
'navigation.html',
'searchbox.html',
]
diff --git a/docs/devel/_templates/editpage.html b/docs/devel/_templates/editpage.html
new file mode 100644
index 0000000000..a86d22bca8
--- /dev/null
+++ b/docs/devel/_templates/editpage.html
@@ -0,0 +1,5 @@
+<div id="editpage">
+ <ul>
+ <li><a href="https://gitlab.com/qemu-project/qemu/-/blob/master/docs/devel/{{pagename}}.rst">Page source</a></li>
+ </ul>
+</div>
diff --git a/docs/interop/_templates/editpage.html b/docs/interop/_templates/editpage.html
new file mode 100644
index 0000000000..215e562681
--- /dev/null
+++ b/docs/interop/_templates/editpage.html
@@ -0,0 +1,5 @@
+<div id="editpage">
+ <ul>
+ <li><a href="https://gitlab.com/qemu-project/qemu/-/blob/master/docs/interop/{{pagename}}.rst">Page source</a></li>
+ </ul>
+</div>
diff --git a/docs/specs/_templates/editpage.html b/docs/specs/_templates/editpage.html
new file mode 100644
index 0000000000..aaa468aa98
--- /dev/null
+++ b/docs/specs/_templates/editpage.html
@@ -0,0 +1,5 @@
+<div id="editpage">
+ <ul>
+ <li><a href="https://gitlab.com/qemu-project/qemu/-/blob/master/docs/specs/{{pagename}}.rst">Page source</a></li>
+ </ul>
+</div>
diff --git a/docs/system/_templates/editpage.html b/docs/system/_templates/editpage.html
new file mode 100644
index 0000000000..6586b2e257
--- /dev/null
+++ b/docs/system/_templates/editpage.html
@@ -0,0 +1,5 @@
+<div id="editpage">
+ <ul>
+ <li><a href="https://gitlab.com/qemu-project/qemu/-/blob/master/docs/system/{{pagename}}.rst">Page source</a></li>
+ </ul>
+</div>
diff --git a/docs/tools/_templates/editpage.html b/docs/tools/_templates/editpage.html
new file mode 100644
index 0000000000..2a9c8fc92b
--- /dev/null
+++ b/docs/tools/_templates/editpage.html
@@ -0,0 +1,5 @@
+<div id="editpage">
+ <ul>
+ <li><a href="https://gitlab.com/qemu-project/qemu/-/blob/master/docs/tools/{{pagename}}.rst">Page source</a></li>
+ </ul>
+</div>
diff --git a/docs/user/_templates/editpage.html b/docs/user/_templates/editpage.html
new file mode 100644
index 0000000000..1f5ee01e60
--- /dev/null
+++ b/docs/user/_templates/editpage.html
@@ -0,0 +1,5 @@
+<div id="editpage">
+ <ul>
+ <li><a href="https://gitlab.com/qemu-project/qemu/-/blob/master/docs/user/{{pagename}}.rst">Page source</a></li>
+ </ul>
+</div>
--
2.18.4
next prev parent reply other threads:[~2020-11-10 11:23 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-11-10 11:11 [PULL 00/19] qtests, gitlab, s390x and misc patches Thomas Huth
2020-11-10 11:11 ` [PULL 01/19] meson: always include contrib/libvhost-user Thomas Huth
2020-11-10 11:11 ` [PULL 02/19] tests/vm: update openbsd to release 6.8 Thomas Huth
2020-11-10 11:11 ` [PULL 03/19] device-crash-test: Check if path is actually an executable file Thomas Huth
2020-11-10 11:11 ` [PULL 04/19] qtest: Fix bad printf format specifiers Thomas Huth
2020-11-10 11:11 ` [PULL 05/19] tests/qtest/tpm: Remove redundant check in the tpm_test_swtpm_test() Thomas Huth
2020-11-10 11:11 ` [PULL 06/19] gitlab-ci: Drop generic cache rule Thomas Huth
2020-11-10 11:11 ` [PULL 07/19] MAINTAINERS: Add gitlab-pipeline-status script to GitLab CI section Thomas Huth
2020-11-10 11:11 ` [PULL 08/19] docs/fuzz: rST-ify the fuzzing documentation Thomas Huth
2020-11-10 11:11 ` [PULL 09/19] docs/fuzz: update fuzzing documentation post-meson Thomas Huth
2020-11-10 11:11 ` [PULL 10/19] scripts/oss-fuzz: give all fuzzers -target names Thomas Huth
2020-11-10 11:11 ` [PULL 11/19] fuzz: Make fork_fuzz.ld compatible with LLVM's LLD Thomas Huth
2020-11-10 11:11 ` [PULL 12/19] configure: surface deprecated targets in the help output Thomas Huth
2020-11-10 11:11 ` [PULL 13/19] gitlab: publish the docs built during CI Thomas Huth
2020-11-10 11:11 ` [PULL 14/19] gitlab: force enable docs build in Fedora, Ubuntu, Debian Thomas Huth
2020-11-10 11:11 ` Thomas Huth [this message]
2020-11-10 11:11 ` [PULL 16/19] fuzz: add virtio-blk fuzz target Thomas Huth
2020-11-10 11:11 ` [PULL 17/19] qtest: Update references to parse_escape() in comments Thomas Huth
2020-11-10 11:11 ` [PULL 18/19] s390x: fix clang 11 warnings in cpu_models.c Thomas Huth
2020-11-10 11:11 ` [PULL 19/19] s390x: Avoid variable size warning in ipl.h Thomas Huth
2020-11-10 14:58 ` [PULL 00/19] qtests, gitlab, s390x and misc patches Peter Maydell
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=20201110111132.559399-16-thuth@redhat.com \
--to=thuth@redhat.com \
--cc=alxndr@bu.edu \
--cc=cohuck@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
/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;
as well as URLs for NNTP newsgroup(s).