All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Daniel P. Berrangé" <berrange@redhat.com>
To: Peter Maydell <peter.maydell@linaro.org>
Cc: "Philippe Mathieu-Daudé" <philmd@redhat.com>,
	"Thomas Huth" <thuth@redhat.com>,
	"Alex Bennée" <alex.bennee@linaro.org>,
	"QEMU Developers" <qemu-devel@nongnu.org>,
	"Wainer dos Santos Moschetta" <wainersm@redhat.com>
Subject: Re: [PATCH 4/4] docs: add "page source" link to sphinx documentation
Date: Mon, 2 Nov 2020 14:23:43 +0000	[thread overview]
Message-ID: <20201102142343.GD138796@redhat.com> (raw)
In-Reply-To: <CAFEAcA8RS2h5V-pSN2B35B-eV4-+wjj2Cdd=PvFTF_qnib9OfQ@mail.gmail.com>

On Mon, Nov 02, 2020 at 01:52:04PM +0000, Peter Maydell wrote:
> On Mon, 2 Nov 2020 at 13:09, Daniel P. Berrangé <berrange@redhat.com> wrote:
> >
> > Add a link to the top of the sidebar in every docs page that takes the
> > user back to the source code in gitlab.
> 
> This doesn't exactly link back to the source code, which is a bit
> confusing I think. Eg the 'page source' link in
> https://berrange.gitlab.io/qemu/system/quickstart.html
> goes to
> https://gitlab.com/qemu-project/qemu/-/blob/master/docs/system/quickstart.rst
> 
> which is a gitlab rendered version of the rST, not a view of
> the actual sources. Is it possible to link directly to an
> "actually the source code" view?

At the top of that page there are two buttons for switching between the
rendered view and source view. I don't think they're directly linkable
as it is switched with javascript.

At least the user can see exactly what source filename is involved though,
which was the key goal I had.

Regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|



  reply	other threads:[~2020-11-02 14:26 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 ` [PATCH 4/4] docs: add "page source" link to sphinx documentation Daniel P. Berrangé
2020-11-02 13:52   ` Peter Maydell
2020-11-02 14:23     ` Daniel P. Berrangé [this message]
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=20201102142343.GD138796@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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.