Author Topic: Python z80 documentation generator  (Read 4690 times)

0 Members and 1 Guest are viewing this topic.

Offline Geekboy1011

  • The Oneironaut
  • Donator
  • LV11 Super Veteran (Next: 3000)
  • ***********
  • Posts: 2031
  • Rating: +119/-2
  • Dream that Awakening dream
    • View Profile
Python z80 documentation generator
« 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

Offline Sorunome

  • Fox Fox Fox Fox Fox Fox Fox!
  • Support Staff
  • LV13 Extreme Addict (Next: 9001)
  • *************
  • Posts: 7920
  • Rating: +374/-13
  • Derpy Hooves
    • View Profile
    • My website! (You might lose the game)
Re: Python z80 documentation generator
« Reply #1 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! :)

THE GAME
Also, check out my website
If OmnomIRC is screwed up, blame me!
Click here to give me an internet!

Offline DJ Omnimaga

  • Clacualters are teh gr33t
  • CoT Emeritus
  • LV15 Omnimagician (Next: --)
  • *
  • Posts: 55942
  • Rating: +3154/-232
  • CodeWalrus founder & retired Omnimaga founder
    • View Profile
    • Dream of Omnimaga Music
Re: Python z80 documentation generator
« Reply #2 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?
Now active at https://discord.gg/cuZcfcF (CodeWalrus server)

Offline Sorunome

  • Fox Fox Fox Fox Fox Fox Fox!
  • Support Staff
  • LV13 Extreme Addict (Next: 9001)
  • *************
  • Posts: 7920
  • Rating: +374/-13
  • Derpy Hooves
    • View Profile
    • My website! (You might lose the game)
Re: Python z80 documentation generator
« Reply #3 on: October 14, 2014, 12:42:54 am »
It is a way to make it easy to index asm routines for later lookup

THE GAME
Also, check out my website
If OmnomIRC is screwed up, blame me!
Click here to give me an internet!

Offline DJ Omnimaga

  • Clacualters are teh gr33t
  • CoT Emeritus
  • LV15 Omnimagician (Next: --)
  • *
  • Posts: 55942
  • Rating: +3154/-232
  • CodeWalrus founder & retired Omnimaga founder
    • View Profile
    • Dream of Omnimaga Music
Re: Python z80 documentation generator
« Reply #4 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?
Now active at https://discord.gg/cuZcfcF (CodeWalrus server)

Offline Sorunome

  • Fox Fox Fox Fox Fox Fox Fox!
  • Support Staff
  • LV13 Extreme Addict (Next: 9001)
  • *************
  • Posts: 7920
  • Rating: +374/-13
  • Derpy Hooves
    • View Profile
    • My website! (You might lose the game)
Re: Python z80 documentation generator
« Reply #5 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.

THE GAME
Also, check out my website
If OmnomIRC is screwed up, blame me!
Click here to give me an internet!

Offline DJ Omnimaga

  • Clacualters are teh gr33t
  • CoT Emeritus
  • LV15 Omnimagician (Next: --)
  • *
  • Posts: 55942
  • Rating: +3154/-232
  • CodeWalrus founder & retired Omnimaga founder
    • View Profile
    • Dream of Omnimaga Music
Re: Python z80 documentation generator
« Reply #6 on: October 14, 2014, 08:23:44 pm »
Ah ok, thanks for the info :)
Now active at https://discord.gg/cuZcfcF (CodeWalrus server)