chardon 0.0.1

Multipurpose tool to parse input file and generate documents. Useful to auto generate browsable documentation.

🌷 Chardon

Chardon is a tool to parse input and generate documents. It can do basic task, such as parsing a Markdown into HTML. But it can handle much more complex task, such as parsing a project code, extracting comment, organizing them as several documentation pages and export them as Markdown or HTML.

Format

Inputs

• : Will parse any properly commented Class, function or field
• : Partially implemented
• : Will be working on soon
• More format may be implemented in the future as the project growth and proposal are prioritized

Outputs

• : Fully implemented
• : Fully implemented
• : Will be working on soon
• : Will be working on soon on a css-stylized HTML
• More format may be implemented in the future as the project growth and proposal are prioritized

Organization

• Simple conversion
• Code comments to functional documentation
• Plain Article to Website pages with content table

How to use it

Github action

Chardon won't be published as Github Action until it reach its first stable release

PyPI

Install Chardon with pip

pip install chardon

Example code

from pathlib import Path
from chardon import CSharpParser, ObsidianFlavoredMarkdownContentExport, ProjectManager

# Specify the path to my project and the output
project = Path('path/to/project')
out = Path('out/doc')

# Select which parser to use
parser = CSharpParser()
# Select which language to export to
exporter = ObsidianFlavoredMarkdownContentExport()

# Parse all the file within project, and export them
project_manager = ProjectManager(parser, exporter, project, out)
project_manager.export()