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 hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page