Skip to main content

Include comments from source file Sphinx extension

Project description

This package contains a comment extractor _Sphinx_ extension.

comment-include is a reStructuredText directive to allow extraction of rst formatted comments from source files.

This extension adds the include-comment directive that automatically extracts the comments begining with /** and creates valid entries for the Sphinx writer used to generate the documentation.

Usage example:

.. include-comment:: file.h

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

sphinxcontrib-cmtinc-0.2.tar.gz (5.3 kB view details)

Uploaded Source

File details

Details for the file sphinxcontrib-cmtinc-0.2.tar.gz.

File metadata

File hashes

Hashes for sphinxcontrib-cmtinc-0.2.tar.gz
Algorithm Hash digest
SHA256 00317f949c7986739cc4cbd16ae9b368fe2b892b32f2886747558f5fe9acdf6f
MD5 e05e39bb59f368f06be65039f5862b54
BLAKE2b-256 b7c2deb8f344c5777ee7cc5e354f9fe4c1f222540c8d3847af7ffc8e135c41f6

See more details on using hashes here.

Supported by

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