Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]


Groups > linux.debian.maint.python > #13234 > unrolled thread

Ported Python Policy to Sphinx

Started byStefano Rivera <stefanor@debian.org>
First post2021-02-26 00:00 +0100
Last post2021-02-28 00:40 +0100
Articles 5 — 2 participants

Back to article view | Back to linux.debian.maint.python


Contents

  Ported Python Policy to Sphinx Stefano Rivera <stefanor@debian.org> - 2021-02-26 00:00 +0100
    Re: Ported Python Policy to Sphinx Dmitry Shachnev <mitya57@debian.org> - 2021-02-26 09:40 +0100
      Re: Ported Python Policy to Sphinx Stefano Rivera <stefanor@debian.org> - 2021-02-26 19:20 +0100
        Re: Ported Python Policy to Sphinx Dmitry Shachnev <mitya57@debian.org> - 2021-02-26 20:20 +0100
          Re: Ported Python Policy to Sphinx Stefano Rivera <stefanor@debian.org> - 2021-02-28 00:40 +0100

#13234 — Ported Python Policy to Sphinx

FromStefano Rivera <stefanor@debian.org>
Date2021-02-26 00:00 +0100
SubjectPorted Python Policy to Sphinx
Message-ID<BMxLZ-tn-5@gated-at.bofh.it>
Hacking on the docbook Python Policy is no fun.

I ported the current version to sphinx.

MR: https://salsa.debian.org/cpython-team/python3-defaults/-/merge_requests/10

Render: https://people.debian.org/~stefanor/python-policy-sphinx/

I'd appreciate it if anyone who has the time would give it a proof-read.

There are definitely sections that could use garbage collection and/or
re-writes for clarity, but the intention of this MR is to just port to
Sphinx without content changes.

There's no direct equivalent in RST for
<literal>python3.<replaceable>Y</replaceable></literal>, the best is
``python3.Y``.
Similarly, I replaced 3<replaceable>Y+1</replaceable> with ``3.(Y+1)``.

SR

-- 
Stefano Rivera
  http://tumbleweed.org.za/
  +1 415 683 3272

[toc] | [next] | [standalone]


#13235

FromDmitry Shachnev <mitya57@debian.org>
Date2021-02-26 09:40 +0100
Message-ID<BMGPg-5YU-3@gated-at.bofh.it>
In reply to#13234

[Multipart message — attachments visible in raw view] — view raw

Hi Stefano!

On Thu, Feb 25, 2021 at 10:58:41PM +0000, Stefano Rivera wrote:
> Hacking on the docbook Python Policy is no fun.
>
> I ported the current version to sphinx.
>
> MR: https://salsa.debian.org/cpython-team/python3-defaults/-/merge_requests/10
>
> Render: https://people.debian.org/~stefanor/python-policy-sphinx/
>
> I'd appreciate it if anyone who has the time would give it a proof-read.
>
> There are definitely sections that could use garbage collection and/or
> re-writes for clarity, but the intention of this MR is to just port to
> Sphinx without content changes.
>
> There's no direct equivalent in RST for
> <literal>python3.<replaceable>Y</replaceable></literal>, the best is
> ``python3.Y``.

You can use :samp:`python3.{Y}`. See:

https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-samp

--
Dmitry Shachnev

[toc] | [prev] | [next] | [standalone]


#13236

FromStefano Rivera <stefanor@debian.org>
Date2021-02-26 19:20 +0100
Message-ID<BMPSy-3bH-3@gated-at.bofh.it>
In reply to#13235
Hi Dmitry (2021.02.26_08:31:11_+0000)
> You can use :samp:`python3.{Y}`. See:

Thanks for the hint. Glad I asked :)

Switched to that, and re-rendered.

SR

-- 
Stefano Rivera
  http://tumbleweed.org.za/
  +1 415 683 3272

[toc] | [prev] | [next] | [standalone]


#13237

FromDmitry Shachnev <mitya57@debian.org>
Date2021-02-26 20:20 +0100
Message-ID<BMQOB-3Ky-3@gated-at.bofh.it>
In reply to#13236

[Multipart message — attachments visible in raw view] — view raw

On Fri, Feb 26, 2021 at 06:09:50PM +0000, Stefano Rivera wrote:
> Hi Dmitry (2021.02.26_08:31:11_+0000)
> > You can use :samp:`python3.{Y}`. See:
>
> Thanks for the hint. Glad I asked :)
>
> Switched to that, and re-rendered.

Small addition (sorry that I did not mention it earlier): when referring
to files you can also use :file:. The difference is only semantic, I think
it will produce the same result:

https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-file

--
Dmitry Shachnev

[toc] | [prev] | [next] | [standalone]


#13238

FromStefano Rivera <stefanor@debian.org>
Date2021-02-28 00:40 +0100
Message-ID<BNhlM-2GY-1@gated-at.bofh.it>
In reply to#13237
Hi Dmitry (2021.02.26_19:10:42_+0000)
> On Fri, Feb 26, 2021 at 06:09:50PM +0000, Stefano Rivera wrote:
> > Hi Dmitry (2021.02.26_08:31:11_+0000)
> > > You can use :samp:`python3.{Y}`. See:
> >
> > Thanks for the hint. Glad I asked :)
> >
> > Switched to that, and re-rendered.
> 
> Small addition (sorry that I did not mention it earlier): when referring
> to files you can also use :file:. The difference is only semantic, I think
> it will produce the same result:

I did that too, and some :envvar: etc.

SR

-- 
Stefano Rivera
  http://tumbleweed.org.za/
  +1 415 683 3272

[toc] | [prev] | [standalone]


Back to top | Article view | linux.debian.maint.python


csiph-web