Skip to main content

cmakedoc makes it easier to search CMake reference documentation.

Project description

Home-page: https://github.com/agateau/cmakedoc Author: Aurélien Gâteau Author-email: mail@agateau.com License: Apache 2.0 Description-Content-Type: text/markdown Description: # 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.

## “Screenshot”

user@host: cmakedoc pkg

# Matching topics: 1: FindPkgConfig (module) 2: UsePkgConfig (module)

Enter topic number or search term (empty input or ‘q’ to quit): 1

## Dependencies

  • cmake (obviously). Must be in $PATH.

  • less, or a pager defined in $PAGER.

## Installation

Using pip:

pip install cmakedoc

Manually:

./setup.py install

Keywords: cmake doc development Platform: UNKNOWN Classifier: Development Status :: 5 - Production/Stable Classifier: Environment :: Console Classifier: Intended Audience :: Developers Classifier: License :: OSI Approved :: Apache Software License Classifier: Operating System :: POSIX :: Linux Classifier: Operating System :: MacOS :: MacOS X Classifier: Programming Language :: Python :: 3 Classifier: Topic :: Software Development :: Build Tools

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cmakedoc-1.0.1.tar.gz (6.8 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page