docwriter 1.1

API reference documentation generator for FreeType.

FreeType Docwriter

Docwriter is an API documentation generator for the FreeType Library that extracts and builds Markdown docs from the FreeType header files.

Installation

Run pip install docwriter. It requires Python 2.7+ or 3.4+ to run.

From repository

1. Clone this repository.

2. Clone the freetype2 repository from here.

3. Run:

   	python -m docwriter                      \
   		--prefix=ft2                     \
   		--title=FreeType-2.9.1           \
   		--output=$./docs/reference       \
   		./include/freetype/*.h           \
   		./include/freetype/config/*.h    \
   		./include/freetype/cache/*.h
   

Usage Information

docwriter [-h] [-t T] -o DIR [-p PRE] [-q | -v] files [files ...]

DocWriter Usage information

positional arguments:
  files                 list of source files to parse, wildcards are allowed

optional arguments:
  -h, --help            show this help message and exit
  -t T, --title T       set project title, as in '-t "My Project"'
  -o DIR, --output DIR  set output directory, as in '-o mydir'
  -p PRE, --prefix PRE  set documentation prefix, as in '-p ft2'
  -q, --quiet           run quietly, show only errors
  -v, --verbose         increase output verbosity

Running Tests

There are two possible test scenarios:

1. Running tests on both py27 and py36 (using tox - requires both python versions installed).
2. Running tests on the currently installed Python version.

They are detailed below.

Test using Tox

To test on both py27 and py36:

1. Make sure tox is installed:

   pip install tox
   

2. Ensure both py27 and py36 are available.

3. Run tests:

   tox
   

Test on single python version

To test on current python version using pytest:

1. Make sure pytest is installed:

   pip install pytest
   

2. Run tests:

   cd tests/
   python -m pytest
   

License

This library is licensed under the FreeType License.

History

This library was originally written by David Turner as docmaker which collected and presented documentation in HTML. It has since been modified multiple times, including a major refactor to allow multiple output formats. The current docwriter is the biggest rewrite, with lots of changes, additions etc. that allow it to be more flexible, readable, maintainable and usable.