Page MenuHomeSoftware Heritage
Differential D7467

docs/cli: Align cli documentation toc setup
ClosedPublic
Actions

Authored by ardumont on Mar 30 2022, 10:37 AM.

Details

Reviewers
anlambert
Group Reviewers
Reviewers
Maniphest Tasks
T4120: Fix documentation dev build (again)
Commits
rDMOD12257c1452e8: docs/cli: Align and fix cli documentation
Summary

This changes the deprecated :show-nested: instruction to the :nested: one [1]

Tentatively trying to fix failing build on master [2] to fix the failing build on doc [3]

[1] https://sphinx-click.readthedocs.io/en/latest/usage/#directive-click

[2] https://jenkins.softwareheritage.org/view/swh-draft/job/DMOD/job/tests/1698/consoleFull

[3] Related to D7445 D7448

Diff Detail

Repository
rDMOD Data model
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.Mar 30 2022, 10:37 AM
Herald added a reviewer: Reviewers. · View Herald TranscriptMar 30 2022, 10:37 AM
swh-public-ci added a comment.Mar 30 2022, 10:39 AM

Build has FAILED

Patch application report for D7467 (id=27064)

Rebasing onto dbce3cc6da...

Current branch diff-target is up to date.
Changes applied before test
commit 77ceb28a75d900cbc98d13b1cb7f66c07ed2572d
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Mar 30 10:31:23 2022 +0200

    docs/cli: Align cli documentation toc setup

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

Harbormaster returned this revision to the author for changes because remote builds failed.Mar 30 2022, 10:39 AM
Harbormaster failed remote builds in B27980: Diff 27064!
ardumont updated this revision to Diff 27070.Mar 30 2022, 10:58 AM

Fix?

swh-public-ci added a comment.Mar 30 2022, 11:01 AM

Build is green

Patch application report for D7467 (id=27070)

Rebasing onto dbce3cc6da...

Current branch diff-target is up to date.
Changes applied before test
commit 12257c1452e88a45012882b28f484a1b8cfc02c0
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Mar 30 10:31:23 2022 +0200

    docs/cli: Align and fix cli documentation
    
    This changes the deprecated :show-nested: instruction to the :nested: one [1].
    This also fixes warning about misdefined block [2]
    
    [1] https://sphinx-click.readthedocs.io/en/latest/usage/#directive-click
    
    [2]
10:38:38  Warning, treated as error:
10:38:38  /var/lib/jenkins/workspace/DMOD/tests-on-diff/docs/cli.rst:14:Literal block expected; none found.
10:38:38  make: *** [../../swh-docs/Makefile.sphinx:32: sphinx/html] Error 2
10:38:38  make: Leaving directory '/var/lib/jenkins/workspace/DMOD/tests-on-diff/docs'
10:38:38  ERROR: InvocationError for command '/usr/bin/make -I ../.tox/sphinx/src/swh-docs/swh/ -C docs' (exited with code 2)
```
See https://jenkins.softwareheritage.org/job/DMOD/job/tests-on-diff/468/ for more details.
Harbormaster completed remote builds in B27986: Diff 27070.Mar 30 2022, 11:01 AM
ardumont requested review of this revision.Mar 30 2022, 11:01 AM
anlambert accepted this revision.Mar 30 2022, 11:02 AM
This revision is now accepted and ready to land.Mar 30 2022, 11:02 AM
ardumont edited the summary of this revision. (Show Details)Mar 30 2022, 11:03 AM
Closed by commit rDMOD12257c1452e8: docs/cli: Align and fix cli documentation (authored by ardumont). · Explain WhyMar 30 2022, 11:04 AM
This revision was automatically updated to reflect the committed changes.
ardumont added a commit: rDMOD12257c1452e8: docs/cli: Align and fix cli documentation.
ardumont added a task: T4120: Fix documentation dev build (again).Mar 30 2022, 4:59 PM

Revision Contents
Changeset List

PathSize
docs/
2 lines
swh/
model/
10 lines

Diff 27072

View Options

docs/cli.rst

Loading...
View Options

swh/model/cli.py

Loading...
About · Developer information · Legal