Git Product home page Git Product logo

haproxy-dconv's Introduction

HAProxy Documentation Converter

In its current state, the HAProxy is converting the HAProxy documentation .txt files into HTML. The purpose of this project is to ultimately convert the HAProxy documentation into a more generic format (example : ReStructuredText) that would allow for an easier spreading of various output files (.pdf, .html, .epub, etc).

Documentation

Python version and requirements

At the moment, we use Mako as a templating engine to render the documentation into HTML format. The current version of the source code is tested against Python 3.6 and Mako version 1.0.6.

Quick execute

# will clone the HAProxy source repository into the './haproxy/' folder
git clone http://git.haproxy.org/git/haproxy.git
# will execute the conversion procedure onto 'haproxy/doc/configuration.txt'
# and output the result into the 'haproxy/doc/configuration.html' file
python dconv.py -g haproxy -o haproxy/doc/ haproxy/doc/configuration.txt

Documentation

A job (see tools/generate-docs.sh) periodically fetches last commits from HAProxy 1.4 to the latest dev branch and produces up-to-date documentation.

Links are available at this URL http://cbonte.github.io/haproxy-dconv/

Contribute

The project now lives by itself, as it is sufficiently useable. But I'm sure we can do even better. Feel free to report feature requests or provide patches !

haproxy-dconv's People

Contributors

cbonte avatar drake-mer avatar git001 avatar glensc avatar mattrobenolt avatar rbu avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.