README
¶
cli-doc
A cli tool developed using GoLang to instantly look up documentation for libraries.
It might only save you two clicks but if you're looking at documentation 100 times a day then you're saving 200 clicks.
How to use
Currently, it only supports few python libraries but the aim is to add all the common libraries as well as eventually add support for other languages.
Use doc to get basic information.
doc help [command] to get information. For example, doc help numpy.
We have also added doc google [search query].
How to install
Installation is very easy if you have go installed. Start by cloning the repository git clone https://github.com/ParthS28/cli-doc, open a terminal and navigate to the repository and type go install. As far as I know, this works perfectly on linux. We still need to check on other OS.
Become a contributor by checking the installation.
Contributing
The code underlying for this is very simple. This is a beginner friendly community. Do not feel overwhelmed and contribute.
TODO
- ability to use it without go installation
- adding support for other OS
- sklearn
- opencv
- sympy
Documentation
¶
Overview ¶
Copyright © 2020 NAME HERE <EMAIL ADDRESS>
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Source Files
Directories