Skip to content
This repository was archived by the owner on Nov 17, 2017. It is now read-only.

neogeek-deprecated/doxdox.py

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

#doxdox

version downloads

A simple documentation generator that takes output from dox and builds a Bootstrap based documentation file.

##Installation

$ pip install --pre doxdox

##Usage

usage: doxdox.py [-h] [-t TITLE] [-d DESCRIPTION] [-l {bootstrap}]
                 [--header HEADER] [--footer FOOTER]
                 [dir]

HTML generator for Dox Documentation (0.3.1alpha)

positional arguments:
  dir                   Directory to search for .json files in.

optional arguments:
  -h, --help            show this help message and exit
  -t TITLE, --title TITLE
                        The project title. Default is "Untitled Project".
  -d DESCRIPTION, --description DESCRIPTION
                        The project description. Default is blank.
  -l {bootstrap}, --layout {bootstrap}
                        The template to render the documentation with. Default
                        is bootstrap.
  --header HEADER       HTML include file (positioned above the content).
  --footer FOOTER       HTML include file (positioned below the content).

##Examples

screenshot

About

HTML documentation generator built in Python.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages