From: "Daniel P. Berrangé" <berrange@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Peter Maydell" <peter.maydell@linaro.org>,
"Thomas Huth" <thuth@redhat.com>,
"Daniel P. Berrangé" <berrange@redhat.com>,
"Alex Bennée" <alex.bennee@linaro.org>,
"Wainer dos Santos Moschetta" <wainersm@redhat.com>,
"Philippe Mathieu-Daudé" <philmd@redhat.com>
Subject: [PATCH 4/4] docs: add "page source" link to sphinx documentation
Date: Mon, 2 Nov 2020 13:09:26 +0000 [thread overview]
Message-ID: <20201102130926.161183-5-berrange@redhat.com> (raw)
In-Reply-To: <20201102130926.161183-1-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>
---
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.28.0
next prev parent reply other threads:[~2020-11-02 13:12 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-11-02 13:09 [PATCH 0/4] Publish docs as GitLab Pages Daniel P. Berrangé
2020-11-02 13:09 ` [PATCH 1/4] gitlab: publish the docs built during CI Daniel P. Berrangé
2020-11-02 13:50 ` Philippe Mathieu-Daudé
2020-11-02 14:21 ` Daniel P. Berrangé
2020-11-02 14:49 ` Philippe Mathieu-Daudé
2020-11-02 13:09 ` [PATCH 2/4] gitlab: force enable docs build in Fedora, Ubuntu, Debian Daniel P. Berrangé
2020-11-02 14:50 ` Philippe Mathieu-Daudé
2020-11-05 10:56 ` Daniel P. Berrangé
2020-11-02 13:09 ` [PATCH 3/4] docs: show stdout/stderr when meson fails build test Daniel P. Berrangé
2020-11-02 13:48 ` Peter Maydell
2020-11-05 11:02 ` Daniel P. Berrangé
2020-11-02 13:09 ` Daniel P. Berrangé [this message]
2020-11-02 13:52 ` [PATCH 4/4] docs: add "page source" link to sphinx documentation Peter Maydell
2020-11-02 14:23 ` Daniel P. Berrangé
2020-11-02 13:45 ` [PATCH 0/4] Publish docs as GitLab Pages Philippe Mathieu-Daudé
2020-11-09 12:10 ` Thomas Huth
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=20201102130926.161183-5-berrange@redhat.com \
--to=berrange@redhat.com \
--cc=alex.bennee@linaro.org \
--cc=peter.maydell@linaro.org \
--cc=philmd@redhat.com \
--cc=qemu-devel@nongnu.org \
--cc=thuth@redhat.com \
--cc=wainersm@redhat.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;
as well as URLs for NNTP newsgroup(s).