A processor to generate Markdown code documentation from OpenSCAD source comments.
Project description
This package generates wiki-ready GitHub flavored markdown documentation pages from in-line source code comments. This is similar to Doxygen or JavaDoc, but designed for use with OpenSCAD code. Example images can be generated automatically from short example scripts.
Documentation about how to add documentation comments to OpenSCAD code can be found at https://github.com/revarbat/openscad_docsgen/blob/main/WRITING_DOCS.md
Using openscad-docsgen
The simplest way to generate documentation is:
% openscad_docsgen *.scad
Which will read all of .scad files in the current directory, and writes out documentation to the ./docs/ dir. To write out to a different directory, use the -D argument:
% openscad_docsgen -D wikidir *.scad
To write out an alphabetical function/module index markdown file, use the -i flag:
% openscad_docsgen -i *.scad
To write out a Table of Contents markdown file, use the -t flag:
% openscad_docsgen -t *.scad
To write out a CheatSheet markdown file, use the -c flag:
% openscad_docsgen -c *.scad
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for openscad_docsgen-1.0.5-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7d8238892a22656be9f5bf37e12b1132b2edc297a29e1e23d87fa03f2060d838 |
|
MD5 | 9accf8e5cce3258cec41c30560d771a9 |
|
BLAKE2b-256 | 044c8696f2c8716ef5c83e7b40cec75516a7c3da0ceee9df6965a6959f4fcf11 |