Paths

Table of Contentst

Differential D6970

docs: Fix sphinx warning
ClosedPublic
Actions

Authored by ardumont on Jan 18 2022, 6:19 PM.

Details

Reviewers

vlorentz

Group Reviewers

Reviewers

Commits

rDFUSEa6c63b9935eb: Convert markdown tutorial to rst

Summary

the tutorial.md suggestion change was fishy and not working [1]

17:21:21  /var/lib/jenkins/workspace/DDOC/build-on-diff/swh-docs/docs/swh-fuse/tutorial.md:85: WARNING: hardcoded link 'https://archive.softwareheritage.org/api/' could be replaced by an extlink (try using ':swh_web:`api/`' instead)

So the tutorial got converted into markdown to nail it.

[1] https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/62/console

Related to D6967

Test Plan

make -C docs happy now

Diff Detail

Repository

rDFUSE FUSE virtual file system

Lint

Automatic diff as part of commit; lint not applicable.

Unit

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

Event Timeline

ardumont created this revision.Jan 18 2022, 6:19 PM

Herald added a reviewer: Reviewers. · View Herald TranscriptJan 18 2022, 6:19 PM

Build has FAILED

Patch application report for D6970 (id=25275)

Rebasing onto e4e75768ac...

Current branch diff-target is up to date.

Changes applied before test

commit 4a7c1d3bae3149f7a391228395d5420d0e4a152f
Author: Antoine R. Dumont (@ardumont) <antoine.romain.dumont@gmail.com>
Date:   Tue Jan 18 18:17:28 2022 +0100

    docs: Fix sphinx warning
    
    Related to D6967

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

Harbormaster returned this revision to the author for changes because remote builds failed.Jan 18 2022, 6:22 PM

Harbormaster failed remote builds in B26134: Diff 25275!

ardumont edited the summary of this revision. (Show Details)Jan 19 2022, 9:40 AM

Fix

Build has FAILED

Patch application report for D6970 (id=25278)

Rebasing onto e4e75768ac...

Current branch diff-target is up to date.

Changes applied before test

commit d4234014c24a85e43fd28f6ca04a6847ff62ffcf
Author: Antoine R. Dumont (@ardumont) <antoine.romain.dumont@gmail.com>
Date:   Tue Jan 18 18:17:28 2022 +0100

    docs: Fix sphinx warning
    
    Related to D6967

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

Harbormaster returned this revision to the author for changes because remote builds failed.Jan 19 2022, 9:45 AM

Harbormaster failed remote builds in B26137: Diff 25278!

Fix by converting the markdown to rst

ardumont edited the summary of this revision. (Show Details)Jan 19 2022, 9:53 AM

ardumont edited the test plan for this revision. (Show Details)

Harbormaster completed remote builds in B26138: Diff 25279.Jan 19 2022, 9:56 AM

Build is green

Patch application report for D6970 (id=25279)

Could not rebase; Attempt merge onto e4e75768ac...

Updating e4e7576..a6c63b9
Fast-forward
 docs/configuration.rst |   3 +-
 docs/tutorial.md       | 260 ---------------------------------------------
 docs/tutorial.rst      | 278 +++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 279 insertions(+), 262 deletions(-)
 delete mode 100644 docs/tutorial.md
 create mode 100644 docs/tutorial.rst

Changes applied before test

commit a6c63b9935eb836e7ef0d9573b1274a02f915624
Author: Antoine R. Dumont (@ardumont) <antoine.romain.dumont@gmail.com>
Date:   Wed Jan 19 09:51:25 2022 +0100

    Convert markdown tutorial to rst
    
    This fixes the warning about the archive.softwareheritage.org link in the markdown.

09:45:50  Warning, treated as error:
09:45:50  /var/lib/jenkins/workspace/DFUSE/tests-on-diff/docs/tutorial.md:85:hardcoded link 'https://archive.softwareheritage.org/api/' could be replaced by an extlink (try using ':swh_web:`api/`' instead)

```

commit d4234014c24a85e43fd28f6ca04a6847ff62ffcf
Author: Antoine R. Dumont (@ardumont) <antoine.romain.dumont@gmail.com>
Date: Tue Jan 18 18:17:28 2022 +0100

docs: Fix sphinx warning

Related to D6967

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

ardumont requested review of this revision.Jan 19 2022, 9:56 AM

vlorentz accepted this revision.Jan 19 2022, 9:56 AM

This revision is now accepted and ready to land.Jan 19 2022, 9:56 AM

I'll keep that solution.
fwiw, i've tried to use [1] in the tutorial.md:

[webapi]: {swh_web}`api/`

but that fails nonetheless:

writing output... [100%] tutorial
/home/tony/work/inria/repo/swh/swh-environment/swh-fuse/docs/tutorial.md:85: WARNING: 'myst' reference target not found: {swh_web}`api/`
generating indices... genindex py-modindex done

[1] https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#roles-an-in-line-extension-point

Closed by commit rDFUSEa6c63b9935eb: Convert markdown tutorial to rst (authored by ardumont). · Explain WhyJan 19 2022, 10:01 AM

This revision was automatically updated to reflect the committed changes.

ardumont added a commit: rDFUSEa6c63b9935eb: Convert markdown tutorial to rst.