This project has been archived by its maintainers, and is no longer receiving any updates.
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.
1 maintainer
Metadata
1 maintainer
Release files for vicdocs 0.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| vicdocs-0.0.1.tar.gz | 3.7 kB | Without provenance | Details for vicdocs-0.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| vicdocs-0.0.1-py3-none-any.whl | Python 3 | none | any | Details for vicdocs-0.0.1-py3-none-any.whl |
Total release size: 7.8 kB
Release files / vicdocs-0.0.1.tar.gz
| Download URL | vicdocs-0.0.1.tar.gz |
|---|---|
| Size | 3.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c14da0daa53ee78261255fcb84622b7f3e9b4763e88f77f329335c460a30f558
|
|
BLAKE2b-256 checksum How to use checksums |
fe65aa335ac9ae44a8ebfdb5c8ec541deefaf16ed9c8c750af3f31a1d4e425c5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.12
|
Release files / vicdocs-0.0.1-py3-none-any.whl
| Download URL | vicdocs-0.0.1-py3-none-any.whl |
|---|---|
| Size | 4.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5e4b25839619ef5ec6aa79662a7c633a09c35796a4ec51f1b3440f8bcd565d3a
|
|
BLAKE2b-256 checksum How to use checksums |
574c73082b3226e5c26c7b353e40d77165b0490184ff1f52b2ece0a6dbf5bc8c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.12
|
Security for vicdocs 0.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
