Page MenuHomeSoftware Heritage

docs/cli: Align cli documentation toc setup
ClosedPublic

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

Details

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/job/DFUSE/job/tests/723/consolex

[3] Related to D7445 D7448

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

Build has FAILED

Patch application report for D7466 (id=27063)

Rebasing onto 3235f05c79...

Current branch diff-target is up to date.
Changes applied before test
commit d213efc1673c5c8661d58d889a0044eea3d3e897
Author: Antoine R. Dumont (@ardumont) <antoine.romain.dumont@gmail.com>
Date:   Wed Mar 30 10:15:27 2022 +0200

    docs/cli: Align cli documentation toc setup

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

Harbormaster returned this revision to the author for changes because remote builds failed.Mar 30 2022, 10:22 AM
Harbormaster failed remote builds in B27979: Diff 27063!
ardumont edited the summary of this revision. (Show Details)

Fix?

Build is green

Patch application report for D7466 (id=27071)

Rebasing onto 3235f05c79...

Current branch diff-target is up to date.
Changes applied before test
commit 88855861f7ede0c818a5a77a24a0fa947e9fe34f
Author: Antoine R. Dumont (@ardumont) <antoine.romain.dumont@gmail.com>
Date:   Wed Mar 30 10:15:27 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 misindented block [2].
    
    [1] https://sphinx-click.readthedocs.io/en/latest/usage/#directive-click
    
    [2]
06:22:34  swh fs mount:1:Unexpected indentation.
06:22:34  make: *** [../../swh-docs/Makefile.sphinx:32: sphinx/html] Error 2
```
See https://jenkins.softwareheritage.org/job/DFUSE/job/tests-on-diff/286/ for more details.
This revision was not accepted when it landed; it landed in state Needs Review.Mar 30 2022, 11:06 AM
ardumont requested review of this revision.
This revision was automatically updated to reflect the committed changes.