Skip to content
Cyril Bonté edited this page Apr 10, 2014 · 11 revisions

v0.3.1

  • Generate documentation for stable releases and snapshots.
  • Several bug fixes

v0.3.0

Generated documentation

  • Migration to Bootstrap 3
  • Use of Twitter typeahead.js for the keyword search field
  • Resources are not embedded anymore : the documentation now uses cdn.js for bootstrap, typeahead and jquery

Converter

  • Detect keyword collision in the same top level chapter
  • Table rendering is not stable enough yes, disable some formats to prevent issues

v0.2.0

Generated documentation

  • New layout
  • Experimental: add keyboard navigation feature using left and right arrows
  • Experimental: add bottom navigation bar
  • Upgraded to Twitter Bootstrap 2.3.1 (patched for dropdown workarounds)

Converter

  • Fix anchors by encoding special chars

v0.1.0

Generated documentation

  • Page header rework to allow the navigation between documentations versions and add links to HAProxy resources
  • Enhanced keyword search
  • Remove the side bar to reintroduce the summary at its original place in the documentation
  • Upgraded to Twitter Bootstrap 2.1.1
  • Icons added in tables

Converter

  • New table format detection
  • Partial “Arguments” block detection
  • Fuzzy underline length detection
  • Fix keyword detection in tables
  • Be less strict on the indentation of “See also” blocks
  • Detect new keyword syntax with optional arguments, introduced in HAProxy 1.5
  • Remove unneeded space between example description ant its content
  • Code & templates cleanup

v0.0.5

Generated documentation

  • “See also” blocks (can use multiple lines) are fully detected and rendered.

Converter

  • Code is slowly becoming more modular
    • The parser is split in several parser modules
    • Each parser module uses its own rendering template

v0.0.4

Generated documentation

  • Example blocks are now detected and rendered (from the simplest form to the most complex)
  • Some keywords were not correctly detected
  • Table headers are automatically repeated for long tables, as it is done in the original documentation

Converter

  • Transform remaining tabulations (if any) into spaces to make the parser simpler
  • HAProxy version is extracted from git if the documentation comes from a git repository

v0.0.3

Generated documentation

  • Comments at the bottom of the documentation are now dropped
  • Fix some links conflicts when keywords are defined in several sections
  • Detection of underlines
  • Colorize “See also :” headers

Converter

  • Ready to parse other documentation files (ie: architecture.txt with some modifications)

Infrastructure

  • A bot is in place to automatically and periodically generate the documentations for HAProxy 1.4 and 1.5

v0.0.2

Generated documentation

  • Add dropdown menus on links targeting keywords defined in several sections
  • Add keywords defined in several sections to the search form
  • Colorize “Arguments :” headers
  • Re-enable table rendering for “May be used in sections” occurences

Converter

  • Add a command line parser
  • Currently detect version from git tags