Skip to content

Documentation Converter from XML to Open Project wiki markup format

Jorge Javier Araya Navarro requested to merge github/fork/shackra/docdump-openproj into master

As posted here help was needed with creating a XML converter to Open Project wiki markup format.

So, here is my PR.

The script works a little different than the other there, it takes more arguments. It requires Python 3.x. I added the option for the developer to choose a output directory, so the directory where the script is ran don't get cluttered with text files.

You can also specify the XML, by default the script will try to open the file class_list.xml that is assumed to be in the same directory. Here is the output of the command --help:

usage: makedocs.py [-h] [--input XMLFP] --output-dir OUTPUTDIR

Generates documentation from a XML file to different markup languages

optional arguments:
  -h, --help            show this help message and exit
  --input XMLFP         Input XML file, default: /home/jorge/godot/tools/docdump/class_list.xml
  --output-dir OUTPUTDIR
                        Output directory for generated files

I'm planning to add later a couple more of output formats, like markdown and dokuwiki (if they are required), and also internationalization because class_list.xml will be subject of translations to several languages in the future.

Merge request reports