diff options
author | Daniel P. Berrangé <berrange@redhat.com> | 2020-11-02 13:09:26 +0000 |
---|---|---|
committer | Thomas Huth <thuth@redhat.com> | 2020-11-10 08:51:30 +0100 |
commit | 704a256da83d6535fce879ba4137299bbe626e5e (patch) | |
tree | 7626a06decdaf5c01e074472991e67f5f01bdc83 /docs | |
parent | d0f26e68a0545db5010e8fac7386739a2c7213b3 (diff) |
docs: add "page source" link to sphinx documentation
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>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/_templates/editpage.html | 5 | ||||
-rw-r--r-- | docs/conf.py | 1 | ||||
-rw-r--r-- | docs/devel/_templates/editpage.html | 5 | ||||
-rw-r--r-- | docs/interop/_templates/editpage.html | 5 | ||||
-rw-r--r-- | docs/specs/_templates/editpage.html | 5 | ||||
-rw-r--r-- | docs/system/_templates/editpage.html | 5 | ||||
-rw-r--r-- | docs/tools/_templates/editpage.html | 5 | ||||
-rw-r--r-- | docs/user/_templates/editpage.html | 5 |
8 files changed, 36 insertions, 0 deletions
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> |