Skip to content

Commit

Permalink
Update the layout of Cargo Commands in doc
Browse files Browse the repository at this point in the history
It seems better to improve the follwing two points.
- A subcategory like `Build Commands` does not contain any contents.
- `Cargo Commands` actually just points to `cargo` command.

So, I fix categories like `Build Commands` to include links to each
commands. In addition, I add `cargo` command to `General Commands`.
  • Loading branch information
giraffate committed Dec 9, 2019
1 parent df80f80 commit 72b5c4e
Show file tree
Hide file tree
Showing 8 changed files with 72 additions and 34 deletions.
63 changes: 32 additions & 31 deletions src/doc/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,41 +34,42 @@
* [Unstable Features](reference/unstable.md)

* [Cargo Commands](commands/index.md)
* [General Commands](commands/general-commands.md)
* [cargo](commands/cargo.md)
* [cargo help](commands/cargo-help.md)
* [cargo version](commands/cargo-version.md)
* [Build Commands](commands/build-commands.md)
* [bench](commands/cargo-bench.md)
* [build](commands/cargo-build.md)
* [check](commands/cargo-check.md)
* [clean](commands/cargo-clean.md)
* [doc](commands/cargo-doc.md)
* [fetch](commands/cargo-fetch.md)
* [fix](commands/cargo-fix.md)
* [run](commands/cargo-run.md)
* [rustc](commands/cargo-rustc.md)
* [rustdoc](commands/cargo-rustdoc.md)
* [test](commands/cargo-test.md)
* [cargo bench](commands/cargo-bench.md)
* [cargo build](commands/cargo-build.md)
* [cargo check](commands/cargo-check.md)
* [cargo clean](commands/cargo-clean.md)
* [cargo doc](commands/cargo-doc.md)
* [cargo fetch](commands/cargo-fetch.md)
* [cargo fix](commands/cargo-fix.md)
* [cargo run](commands/cargo-run.md)
* [cargo rustc](commands/cargo-rustc.md)
* [cargo rustdoc](commands/cargo-rustdoc.md)
* [cargo test](commands/cargo-test.md)
* [Manifest Commands](commands/manifest-commands.md)
* [generate-lockfile](commands/cargo-generate-lockfile.md)
* [locate-project](commands/cargo-locate-project.md)
* [metadata](commands/cargo-metadata.md)
* [pkgid](commands/cargo-pkgid.md)
* [update](commands/cargo-update.md)
* [vendor](commands/cargo-vendor.md)
* [verify-project](commands/cargo-verify-project.md)
* [cargo generate-lockfile](commands/cargo-generate-lockfile.md)
* [cargo locate-project](commands/cargo-locate-project.md)
* [cargo metadata](commands/cargo-metadata.md)
* [cargo pkgid](commands/cargo-pkgid.md)
* [cargo update](commands/cargo-update.md)
* [cargo vendor](commands/cargo-vendor.md)
* [cargo verify-project](commands/cargo-verify-project.md)
* [Package Commands](commands/package-commands.md)
* [init](commands/cargo-init.md)
* [install](commands/cargo-install.md)
* [new](commands/cargo-new.md)
* [search](commands/cargo-search.md)
* [uninstall](commands/cargo-uninstall.md)
* [cargo init](commands/cargo-init.md)
* [cargo install](commands/cargo-install.md)
* [cargo new](commands/cargo-new.md)
* [cargo search](commands/cargo-search.md)
* [cargo uninstall](commands/cargo-uninstall.md)
* [Publishing Commands](commands/publishing-commands.md)
* [login](commands/cargo-login.md)
* [owner](commands/cargo-owner.md)
* [package](commands/cargo-package.md)
* [publish](commands/cargo-publish.md)
* [yank](commands/cargo-yank.md)
* [General Commands](commands/general-commands.md)
* [help](commands/cargo-help.md)
* [version](commands/cargo-version.md)
* [cargo login](commands/cargo-login.md)
* [cargo owner](commands/cargo-owner.md)
* [cargo package](commands/cargo-package.md)
* [cargo publish](commands/cargo-publish.md)
* [cargo yank](commands/cargo-yank.md)

* [FAQ](faq.md)
* [Appendix: Glossary](appendix/glossary.md)
Expand Down
11 changes: 11 additions & 0 deletions src/doc/src/commands/build-commands.md
Original file line number Diff line number Diff line change
@@ -1 +1,12 @@
# Build Commands
* [cargo bench](cargo-bench.md)
* [cargo build](cargo-build.md)
* [cargo check](cargo-check.md)
* [cargo clean](cargo-clean.md)
* [cargo doc](cargo-doc.md)
* [cargo fetch](cargo-fetch.md)
* [cargo fix](cargo-fix.md)
* [cargo run](cargo-run.md)
* [cargo rustc](cargo-rustc.md)
* [cargo rustdoc](cargo-rustdoc.md)
* [cargo test](cargo-test.md)
3 changes: 3 additions & 0 deletions src/doc/src/commands/cargo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# cargo
{{#include command-common.html}}
{{#include ../../man/generated/cargo.html}}
3 changes: 3 additions & 0 deletions src/doc/src/commands/general-commands.md
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
# General Commands
* [cargo](cargo.md)
* [cargo help](cargo-help.md)
* [cargo version](cargo-version.md)
9 changes: 6 additions & 3 deletions src/doc/src/commands/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# cargo
{{#include command-common.html}}
{{#include ../../man/generated/cargo.html}}
# Cargo Commands
* [General Commands](general-commands.md)
* [Build Commands](build-commands.md)
* [Manifest Commands](manifest-commands.md)
* [Package Commands](package-commands.md)
* [Publishing Commands](publishing-commands.md)
7 changes: 7 additions & 0 deletions src/doc/src/commands/manifest-commands.md
Original file line number Diff line number Diff line change
@@ -1 +1,8 @@
# Manifest Commands
* [cargo generate-lockfile](cargo-generate-lockfile.md)
* [cargo locate-project](cargo-locate-project.md)
* [cargo metadata](cargo-metadata.md)
* [cargo pkgid](cargo-pkgid.md)
* [cargo update](cargo-update.md)
* [cargo vendor](cargo-vendor.md)
* [cargo verify-project](cargo-verify-project.md)
5 changes: 5 additions & 0 deletions src/doc/src/commands/package-commands.md
Original file line number Diff line number Diff line change
@@ -1 +1,6 @@
# Package Commands
* [cargo init](cargo-init.md)
* [cargo install](cargo-install.md)
* [cargo new](cargo-new.md)
* [cargo search](cargo-search.md)
* [cargo uninstall](cargo-uninstall.md)
5 changes: 5 additions & 0 deletions src/doc/src/commands/publishing-commands.md
Original file line number Diff line number Diff line change
@@ -1 +1,6 @@
# Publishing Commands
* [cargo login](cargo-login.md)
* [cargo owner](cargo-owner.md)
* [cargo package](cargo-package.md)
* [cargo publish](cargo-publish.md)
* [cargo yank](cargo-yank.md)

0 comments on commit 72b5c4e

Please sign in to comment.