Metadata-Version: 2.1
Name: openscad-docsgen
Version: 1.0.2
Summary: A processor to generate Markdown code documentation from OpenSCAD source comments.
Home-page: https://github.com/revarbat/openscad_docsgen
Author: Revar Desmera
Author-email: revarbat@gmail.com
License: MIT License
Download-URL: https://github.com/revarbat/openscad_docsgen/archive/v1.0.2.zip
Keywords: openscad documentation generation docsgen
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Manufacturing
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Artistic Software
Classifier: Topic :: Multimedia :: Graphics :: 3D Modeling
Classifier: Topic :: Multimedia :: Graphics :: 3D Rendering
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/x-rst
Requires-Dist: setuptools
Requires-Dist: Pillow (>=7.2.0)
Requires-Dist: openscad-runner (>=1.0.7)

################################
OpenSCAD Documentation Generator
################################

This package generates wiki-ready 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.rst`


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




