Command line tool to read cmake documentation
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
CHANGELOG.md
COPYING
MANIFEST.in
README.md
cmakedoc.py
demo.gif
setup.py

README.md

CMakeDoc

What is it?

CMakeDoc is a command-line tool to read CMake documentation. It lets you search through CMake commands, modules, variables and properties before displaying the selected topic with less or the pager defined in $PAGER.

Demo

CMakedoc demonstration

Dependencies

  • cmake (obviously). Must be in $PATH.
  • less, or a pager defined in $PAGER.

Installation

Using pip:

pip install cmakedoc

Manually:

./setup.py install