https://github.com/nonunknown/integrated-docs
https://github.com/nonunknown/integrated-docs
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/nonunknown/integrated-docs
- Owner: nonunknown
- License: mit
- Created: 2020-04-05T18:15:41.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-04-06T10:03:08.000Z (about 6 years ago)
- Last Synced: 2025-03-02T04:43:39.305Z (about 1 year ago)
- Language: GDScript
- Size: 848 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Integrated Documentation - WIP
known as Integrated Docs
## Its Finished?
It is work in progress, the hard part is done, now I just need to add support for method args, and make some adjustments to RST reader.
## What this is?
It let the user generate documentation for any .gd (GDScript file) since is well commented.
## How it works?
Generates a .rst based on .gd comments
Reads these .rst generated files inside the engine
## Any Example?
yes, just look for the GDReader file how it is commented, and look at the generated_docs/ folder for the result.
## Can I see it working?
yes, Open the Control.tscn and click at the panel node, click update, press f6 and you're done.
https://imgur.com/F752MUC