Light Python-API Documentation in markdown and html
Project description
Clamming - Light Python-API Documentation in markdown and html
Overview
Clamming means fishing the seashells "clams" on a beach. Here we're fishing the documentation in a python source code...
Clamming is a simple library useful to convert a python class
into
a markdown or html file, for documentation purpose. The Vehicle
sample
is illustrating the supported format.
Notice that we expect to generate HTML-5 with WCAG 2.1 conformity, however it was not verified.
Author
Copyright (C) 2023 - Brigitte Bigi - develop@sppas.org Laboratoire Parole et Langage, Aix-en-Provence, France
License
This is the implementation of the Clamming
library, under the terms of
the GNU General Public License version 3.
Install Clamming
From clamming repo:
Download the repository and unpack it. Clamming package includes the following folders and files:
- "clamming": the source code folder
- "docs": the documentation of clamming in HTML
- "tests": unittest of clamming source code
- "sample": includes a sample class
Vehicle
to illustrateclamming
use - "sample.py": an example of use
- "makedoc.py": create the Clamming documentation, using Clamming library
- "etc": etcetera!
Take a look at the sample.py and makedoc.py files.
From clamming package:
Install it in your python environment from the local wheel with:
> python -m pip install dist/<clamming.whl>
Example of use
>>> import clamming
>>> import Vehicle # Any python class to be documented
>>> cp = clamming.ClammingParser(Vehicle)
>>> clams = ClamsClass(cp)
>>> print(clams.html())
>>> print(clams.markdown())
See Clamming documentation for extended usages.
Projects using Clamming
- Clamming
- SPPAS http://sppas/org (asap...)
- contact the author if you want to add a project here
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.