New documentation

We build documentation and host it in Read the Docs.

All documentation files are stored only in gh-pages branch, with the following directory structure:

docs
├── _config.yml
├── devel-docs
├── docs
└── index.rst

Documentation is created using reStructuredText , is an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser system.

Procedure

  1. Consider the editing style of existing pages.
  2. Edit a doc page or create a new one in gh-pages branch.
  3. Insert in index.rst according to the section.

Note

Documentation web is updated automatically, thanks to Read the Docs.

Convert POD files

Install libpod-pom-view-restructured-perl in your computer.