cli: Fix sphinx warning
ClosedPublic
Actions

Authored by anlambert on Apr 16 2021, 2:14 PM.

Details

Reviewers

None

Group Reviewers

Reviewers

Maniphest Tasks

T2265: Building the documentation should not show any warning.

Commits

rDGRPH04a1656c104e: cli: Fix sphinx warning

Summary

This fixes the following warning:

<generated>:1: WARNING: Inline emphasis start-string without end-string.

Related to T2265

Diff Detail

Repository

rDGRPH Compressed graph representation

Lint

Automatic diff as part of commit; lint not applicable.

Unit

Automatic diff as part of commit; unit tests not applicable.

Event Timeline

anlambert created this revision.Apr 16 2021, 2:14 PM

Herald added a reviewer: Reviewers. · View Herald TranscriptApr 16 2021, 2:14 PM

anlambert mentioned this in D5544: docs/cli: Fix sphinx warning.Apr 16 2021, 2:16 PM

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

Build is green

Patch application report for D5546 (id=19794)

Rebasing onto e86a39d9dc...

Current branch diff-target is up to date.

Changes applied before test

commit a5ca64d77e0304992d1884c9ec7de45937d7d1df
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Fri Apr 16 14:12:40 2021 +0200

    cli: Fix sphinx warning
    
    This fixes the following warning:
    
    <generated>:1: WARNING: Inline emphasis start-string without end-string.
    
    Related to T2265

See https://jenkins.softwareheritage.org/job/DGRPH/job/tests-on-diff/82/ for more details.

Harbormaster completed remote builds in B20807: Diff 19794.Apr 16 2021, 2:26 PM

anlambert requested review of this revision.Apr 16 2021, 2:26 PM

Use :file: role instead of escaping *.

Build has FAILED

Patch application report for D5546 (id=19797)

Rebasing onto e86a39d9dc...

Current branch diff-target is up to date.

Changes applied before test

commit 04a1656c104ee2af915c745f24e7b05371c12c93
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Fri Apr 16 14:12:40 2021 +0200

    cli: Fix sphinx warning
    
    This fixes the following warning:
    
    <generated>:1: WARNING: Inline emphasis start-string without end-string.
    
    Related to T2265

Link to build: https://jenkins.softwareheritage.org/job/DGRPH/job/tests-on-diff/83/
See console output for more information: https://jenkins.softwareheritage.org/job/DGRPH/job/tests-on-diff/83/console

Harbormaster failed remote builds in B20810: Diff 19797!Apr 16 2021, 2:36 PM

Build is green

Patch application report for D5546 (id=19797)

Rebasing onto e86a39d9dc...

Current branch diff-target is up to date.

Changes applied before test

commit 04a1656c104ee2af915c745f24e7b05371c12c93
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Fri Apr 16 14:12:40 2021 +0200

    cli: Fix sphinx warning
    
    This fixes the following warning:
    
    <generated>:1: WARNING: Inline emphasis start-string without end-string.
    
    Related to T2265

See https://jenkins.softwareheritage.org/job/DGRPH/job/tests-on-diff/84/ for more details.

Harbormaster completed remote builds in B20810: Diff 19797.Apr 16 2021, 2:38 PM

This revision was not accepted when it landed; it landed in state Needs Review.Apr 16 2021, 2:38 PM

Closed by commit rDGRPH04a1656c104e: cli: Fix sphinx warning (authored by anlambert). · Explain Why

This revision was automatically updated to reflect the committed changes.

anlambert added a commit: rDGRPH04a1656c104e: cli: Fix sphinx warning.