Differential D5695

docs/cli: Remove nested option for root swh command
ClosedPublic
Actions

Authored by anlambert on May 6 2021, 1:43 PM.

Details

Reviewers

ardumont

Group Reviewers

Reviewers

Commits

rDCORE5f9527f0bffa: docs/cli: Remove nested option for root swh command

Summary

When building the global swh documentation, all commands defined
in other swh packages will be insterted in the swh.core cli
documentation but we only want to document the root command here.

This also fixes the remaining sphinx warning when building the global
swh documentation.

Diff Detail

Repository

rDCORE Foundations and core functionalities

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.May 6 2021, 1:43 PM

Herald added a reviewer: Reviewers. · View Herald TranscriptMay 6 2021, 1:43 PM

Build is green

Patch application report for D5695 (id=20338)

Rebasing onto 4d70ee0cfa...

Current branch diff-target is up to date.

Changes applied before test

commit 5f9527f0bffa83995fec90f08f3b0c9c747a28bf
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Thu May 6 13:39:10 2021 +0200

    docs/cli: Remove nested option for root swh command
    
    When building the global swh documentation, all commands defined
    in other swh packages will be insterted in the swh.core cli
    documentation but we only want to document the root command here.
    
    This also fixes the remaining sphinx warning when building the global
    swh documentation.

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

Harbormaster completed remote builds in B21320: Diff 20338.May 6 2021, 1:45 PM

anlambert requested review of this revision.May 6 2021, 1:45 PM

ardumont accepted this revision.May 6 2021, 1:50 PM

This revision is now accepted and ready to land.May 6 2021, 1:50 PM

Closed by commit rDCORE5f9527f0bffa: docs/cli: Remove nested option for root swh command (authored by anlambert). · Explain WhyMay 6 2021, 1:55 PM

This revision was automatically updated to reflect the committed changes.

anlambert added a commit: rDCORE5f9527f0bffa: docs/cli: Remove nested option for root swh command.