Auto-generate Nasal API documentation from the FlightGear Nasal folder
Project description
Nasal API Docs
Auto generates Nasal API documentation from FlightGear's nasal scripts.
- Original python2 script by Adrian Musceac @2012.
- Refactored into a package by RenanMsV @2019-2026.
Latest generated docs
📃 View the latest docs here: nasal-api-docs/latest.
Requirements
-
Requires Python 3.7 or newer.
-
Uses Jinja2 module to generate the HTML. To install Jinja2 run the console command below:
pip install jinja2
How to install and run:
Install with:
pip install .
Run the command:
nasal-api-docs -f /path/to/FlightGear/data -o /path/to/output/
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file nasal_api_docs-0.2.0.tar.gz.
File metadata
- Download URL: nasal_api_docs-0.2.0.tar.gz
- Upload date:
- Size: 23.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a16a854dc834111361484d13c29508228eca3e574edbf1137ecd32d10abea106
|
|
| MD5 |
7c0e942e2e257454e06ff43d826823fe
|
|
| BLAKE2b-256 |
c1f1d584ec374f12e94320a2cc5c9aac435b76b070c5cb05fb0a39fadccbb210
|
File details
Details for the file nasal_api_docs-0.2.0-py3-none-any.whl.
File metadata
- Download URL: nasal_api_docs-0.2.0-py3-none-any.whl
- Upload date:
- Size: 28.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
57561b79f520a2ab097136b8c737b0c4cd5d72cce6f4967d0b840ec7a7997fdd
|
|
| MD5 |
e19a54c5b067f4b294fffab74242ff3f
|
|
| BLAKE2b-256 |
982cfedd079da0c7ff866b35b4b35ebcf4fe756b04edfb8292995c4d808c65b1
|
