Cli Rustdoc

Builds/finds documentation for Rust package or library

---

• ⬆️ Top of Document

• 🏗️ Requirements

• ⚡ Quick Start

  • 💾 Clone
  • ➕ Install
  • 🔥 Uninstall
  • ⬆️ Upgrade
  • 📑 Documentation

• 🧰 Usage

• 🗒 Notes

• 📈 Contributing

  • 🔱 Forking
  • 💱 Sponsor

• 📇 Attribution

• ⚖️ Licensing

---

Requirements

Awk, GAwk, or MAwk must be installed to make use of scripts within this repository, for Debian based Linux distributions that'd look similar to...

sudo apt-get install gawk

This repository makes use of Git Submodules to track Bash script dependencies, to avoid incomplete downloads clone with the --recurse-submodules option...

git clone --recurse-submodules git@github.com:rust-utilities/cli-rustdoc.git

To update tracked Git Submodules issue the following commands...

git pull

git submodule update --init --merge --recursive

To force upgrade of Git Submodules...

git submodule update --init --merge --recursive --remote

Note, forcing and update of Git Submodule tracked dependencies may cause instabilities and/or merge conflicts; if however everything operates as expected after an update please consider submitting a Pull Request.

---

Quick Start

Perhaps as easy as one, 2.0,...

---

Clone

Clone this project...

mkdir -vp ~/git/hub/rust-utilities

cd ~/git/hub/rust-utilities

git clone --recurse-submodules git@github.com:rust-utilities/cli-rustdoc.git

---

Install

Install via make install command...

cd ~/git/hub/rust-utilities/cli-rustdoc

make install

---

Uninstall

Uninstall via uninstall Make target...

cd ~/git/hub/rust-utilities/cli-rustdoc

make uninstall

... Which will remove symbolic links for script(s) and manual page(s).

---

Upgrade

To update in the future use make upgrade command...

cd ~/git/hub/rust-utilities/cli-rustdoc

make upgrade

---

Documentation

After installation, documentation may be accessed via man command, eg...

man cli-rustdoc

---

Usage

cli-rustdoc 'version_operators'

The --help parameter may be used to print usage documentation, and when combined with --verbose will print parsed options, eg...

cli-rustdoc --help --verbose

Defaults may be defined via .config-cli-rustdoc file placed within the repository directory, eg...

_keep=1
_browser='w3m'
_dependency_section='documentation.dependencies'
_directory="${HOME}/.local/share/cli-rustdoc"

---

Notes

This repository may not be feature complete and/or fully functional, Pull Requests that add features or fix bugs are certainly welcomed.

Currently this project is a set of Awk and Bash scripts, however, in the future source code may be translated to Rust if there is sufficient reason and interest.

---

Contributing

Options for contributing to cli-rustdoc and rust-utilities

---

Forking

Start making a Fork of this repository to an account that you have write permissions for.

• Add remote for fork URL. The URL syntax is git@github.com:<NAME>/<REPO>.git...

cd ~/git/hub/rust-utilities/cli-rustdoc

git remote add fork git@github.com:<NAME>/cli-rustdoc.git

• Commit your changes and push to your fork, eg. to fix an issue...

cd ~/git/hub/rust-utilities/cli-rustdoc


git commit -F- <<'EOF'
:bug: Fixes #42 Issue


**Edits**


- `<SCRIPT-NAME>` script, fixes some bug reported in issue
EOF


git push fork main

Note, the -u option may be used to set fork as the default remote, eg. git push -u fork main however, this will also default the fork remote for pulling from too! Meaning that pulling updates from origin must be done explicitly, eg. git pull origin main

• Then on GitHub submit a Pull Request through the Web-UI, the URL syntax is https://github.com/<NAME>/<REPO>/pull/new/<BRANCH>

Note; to decrease the chances of your Pull Request needing modifications before being accepted, please check the dot-github repository for detailed contributing guidelines.

---

Sponsor

Thanks for even considering it!

Via Liberapay you may on a repeating basis.

Regardless of if you're able to financially support projects such as cli-rustdoc that rust-utilities maintains, please consider sharing projects that are useful with others, because one of the goals of maintaining Open Source repositories is to provide value to the community.

---

Attribution

• GitHub -- github-utilities/make-readme

• StackOverflow -- How do I access the API documentation from the command line on Linux?

---

License

Builds/finds documentation for Rust package or library
Copyright (C) 2021 S0AndS0

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, version 3 of the License.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

For further details review full length version of AGPL-3.0 License.