Page MenuHomePhabricator

Sphinx: replace :note: field element with .. note:: directive
Closed, ResolvedPublic

Description

Introduction

Sphinx provides a note directive like

.. note:: This is a note
   over two source lines

https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html?highlight=%3Anote%3A#directive-note

NOTE: There is a single space after the two dots and there are two colons after 'note' without space.

There are some notes in our documentation with uses a field entry syntay like

:note: This is a note
    over two source lines

What to do

Replace the old field elements with the newer directive. See the sample above.

The .. note:: directive must be separated with a newline. Also align the second line (and additional lines) with 'note' word as shown above

The issues can be found here:
https://codesearch.wmcloud.org/pywikibot/?q=%3Anote%3A&i=nope&files=&excludeFiles=&repos=

Usefull links

Event Timeline

Xqt triaged this task as Lowest priority.May 15 2022, 9:59 AM

Change 791730 had a related patch set uploaded (by Klein Muçi; author: Klein Muçi):

[pywikibot/core@master] Sphinx: replace :note: field element with .. note:: directive

https://gerrit.wikimedia.org/r/791730

Change 791730 merged by jenkins-bot:

[pywikibot/core@master] Sphinx: replace :note: field element with .. note:: directive

https://gerrit.wikimedia.org/r/791730