tree: 4235e37767729c70d8e25f02ad06c671a691c799
  1. books/
  2. man/
  3. notes/
  4. CMakeLists.txt
  5. README.md
docs/README.md

Qpid Dispatch documentation

Building the documentation

Documentation is built when you run make docs. You need the following tools to build the documentation.

  • asciidoctor (1.5.6) for books
  • asciidoc (8.6.8) for man pages

The versions above are known to work, earlier versions may or may not.

Writing documentation

Documentation is written in AsciiDoc markup.

  • ‘books/’: AsciiDoc source for the user guide
  • ‘man/’: AsciiDoc source for Unix man pages
  • ‘notes/’: Developer notes: project information, design notes, or anything else that's primarily of developer interest; these are not installed.