https://github.com/capjamesg/vicdocs
Generate documentation for single-file VisionScript projects.
https://github.com/capjamesg/vicdocs
documentation visionscript
Last synced: 11 months ago
JSON representation
Generate documentation for single-file VisionScript projects.
- Host: GitHub
- URL: https://github.com/capjamesg/vicdocs
- Owner: capjamesg
- License: mit
- Created: 2023-08-18T21:41:16.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-18T21:43:42.000Z (over 2 years ago)
- Last Synced: 2025-03-28T19:16:41.007Z (11 months ago)
- Topics: documentation, visionscript
- Language: Python
- Homepage: https://visionscript.dev/documenting/
- Size: 143 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vicdocs
`vicdocs` is a documentation generator for [VisionScript](https://visionscript.dev).
`vicdocs` reads a VisionScript file (`.vic`), parses the comments, and generates a HTML document with:
1. The program code;
2. The title, description, and author information specified (if any);
3. 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`:
```bash
pip install vicdocs
```
## Usage
To generate a documentation file, run `vicdocs` with the path to the VisionScript file as the first argument:
```bash
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](LICENSE).