https://github.com/knightos/kdoc
Documentation generator for assembly projects
https://github.com/knightos/kdoc
Last synced: 10 months ago
JSON representation
Documentation generator for assembly projects
- Host: GitHub
- URL: https://github.com/knightos/kdoc
- Owner: KnightOS
- License: other
- Created: 2013-09-16T22:58:44.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2017-06-26T20:10:49.000Z (over 8 years ago)
- Last Synced: 2025-04-02T03:43:14.647Z (11 months ago)
- Language: Python
- Homepage:
- Size: 30.3 KB
- Stars: 2
- Watchers: 12
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# kdoc
This tool generates documentation for assembly projects. Write your code like this:
;; functionName [Category]
;; Description description description description
;; description description description description
;; description description description
;; Inputs:
;; Register: description
;; Register: description
;; Outputs:
;; Register: description
And then run `python -m kdoc categories.yaml $(cd kernel && git log -1 --format=%H) $(find kernel/src -type f)` to get docs in html/.
## Help, Bugs, Feedback
If you need help with KnightOS, want to keep up with progress, chat with
developers, or ask any other questions about KnightOS, you can hang out in the
IRC channel: [#knightos on irc.freenode.net](http://webchat.freenode.net/?channels=knightos).
To report bugs, please create [a GitHub issue](https://github.com/KnightOS/KnightOS/issues/new) or contact us on IRC.
If you'd like to contribute to the project, please see the [contribution guidelines](http://www.knightos.org/contributing).