Omnimaga

Calculator Community => TI Calculators => ASM => Topic started by: Geekboy1011 on October 11, 2014, 08:20:37 pm

Title: Python z80 documentation generator
Post by: Geekboy1011 on October 11, 2014, 08:20:37 pm
So me and Iambian have been working on projects and one of our biggest issues has been keeping everything even remotely documented.

So I whipped up this python script to parse specially formatted comments and spit out a text file containing all the information in a slightly organized fashion. In an attempt to force us to at least put some kind of documentation down.

Also supports Spitting out a to do file.

I plan on making it support some kinda HTML output at some point. But I have yet to figure out how I want to do that. (CHMs would be nice but google failed me :()

Python Script :
https://bitbucket.org/Geekboy1011/pythonz80doc
Title: Re: Python z80 documentation generator
Post by: Sorunome on October 12, 2014, 06:37:24 am
this is looking pretty sweet!
You could make like a online database thingy with this where anyone can submit! :)
Title: Re: Python z80 documentation generator
Post by: DJ Omnimaga on October 14, 2014, 12:40:03 am
I'm unsure if I understand what is the purpose of this so I'm probably missing something: Is it like RunerBot on IRC where it spits out doc when entering a command or instruction? Is it an offline version of WikiTI? Is it a syntax colorizer/commenter or is it a python<>Z80 ASM code converter?
Title: Re: Python z80 documentation generator
Post by: Sorunome on October 14, 2014, 12:42:54 am
It is a way to make it easy to index asm routines for later lookup
Title: Re: Python z80 documentation generator
Post by: DJ Omnimaga on October 14, 2014, 03:20:26 am
So I assume it takes your ASM source then create a file listing the documentation of only the commands you have used so far?
Title: Re: Python z80 documentation generator
Post by: Sorunome on October 14, 2014, 07:03:20 am
In your comments you describe the routines you use, and then you can look up the routines later.
Title: Re: Python z80 documentation generator
Post by: DJ Omnimaga on October 14, 2014, 08:23:44 pm
Ah ok, thanks for the info :)