No project description provided
Project description
vicdocs
vicdocs
is a documentation generator for VisionScript.
vicdocs
reads a VisionScript file (.vic
), parses the comments, and generates a HTML document with:
- The program code;
- The title, description, and author information specified (if any);
- A list of function definitions.
vicdocs
only works with single-file scripts.
Installation
vicdocs
is available on PyPI, so you can install it with pip
:
pip install vicdocs
Usage
To generate a documentation file, run vicdocs
with the path to the VisionScript file as the first argument:
vicdocs file.vic
This will generate a HTML file in a {file}-docs
, where {file}
is the name of the VisionScript file for which you are generating documentation.
License
This project is licensed under an MIT license.
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 Distribution
vicdocs-0.0.1.tar.gz
(3.7 kB
view hashes)