Skip to main content

Generate reStructuredText documentations from your C++ sources

Project description

License GPLv3

DoxyCast is a documentation generator that helps you to generate beautiful documentations from the comments you have written in your source code.

DoxyCast reads the XML output from Doxygen and generates reStructuredText sources, which are parsed by Sphinx to generate the documentations.

Installation

To install DoxyCast, execute the following command:

pip install doxycast

Getting Started

Before getting started, make sure you have Doxygen and Sphinx installed. Then add the following to your conf.py:

doxycast_config = {
    "projects": {
        "xml_dir": "path/to/xml",
        "output_dir": "path/to/output",
        "execute_doxygen": True,
        "doxycast_config":
            "INPUT = path/to/sources\n"
            # Other Doxygen options

        # "writer": your_custom_writer # Optional, default ``doxycast.writers.default``
    }
}

Note: if you are using the default writer (not using any custom writer), you also need to install Breathe.

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

doxycast-2.0.0.tar.gz (12.7 kB view hashes)

Uploaded source

Built Distribution

doxycast-2.0.0-py3-none-any.whl (29.0 kB view hashes)

Uploaded py3

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