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.
1 maintainer
Metadata
1 maintainer
Release files for doxycast 2.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| doxycast-2.0.0.tar.gz | 12.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| doxycast-2.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 41.7 kB
Release files / doxycast-2.0.0.tar.gz
| Download URL | doxycast-2.0.0.tar.gz |
|---|---|
| Size | 12.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0193fef4efddbd43c9ee96b667d4557c005cab4a39021a3b875f2762539fd91a
|
|
BLAKE2b-256 checksum How to use checksums |
f1bfaf372b65db793fc183eb8748c597942f04a9a3be451e2f2e4b82a43abf47
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.6.1 requests/2.24.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.55.0 CPython/3.8.5
|
Release files / doxycast-2.0.0-py3-none-any.whl
| Download URL | doxycast-2.0.0-py3-none-any.whl |
|---|---|
| Size | 29.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a2a26632be7c6aa4ab597fa283ac5ae603460d8778d3a64fc3141798f62cbbad
|
|
BLAKE2b-256 checksum How to use checksums |
df46c3d2c5bf0ef01de743e249393499cf2936d7f6d6f9dfb044cb50a8dd68d9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.6.1 requests/2.24.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.55.0 CPython/3.8.5
|
