This README file contains the some useful notice about the ArcheOS documentation package and source. The documentation is build using [Sphinx] 1, so check how to use it and all the dependencies into the "Dependencies" section.
The aim of this documentation is to provide a single entry-point where all resources about ArcheOS are stored and where all people working on the distribution can collaborate. The documentation is written in the [Markdown] 2 markup language, then compiled in various formats (see Formats section). HTML and MAN pages are used to build the debian package too, while other formats (HTML, ePub, PDF, etc.) are made available to the ArcheOS website (see Automation section).
This repository contains the debian files used to build the package as well as the documentation itself.
├── build Where output files are produced and stored. Largely ingored by git
├── debian Debian packaging files
│ ├── ...
|
├── Makefile Makefile to build the various targets
├── README.md The file you are reading
└── source Source files that will be compiled
| ├── conf.py Configuration for Sphinx
| ├── index.rst Main source file
| ├── _static Folder where CSS are placed
| └── _templates Folder where HTML templates are placed
The ArcheOS documentation has been built successfully with these packages:
- Python 2.7.3 or higher
- Sphinx 1.1.3 or higher (better installed with easy_install into virtualenv)
- Markdown 2.2.1 or higher
- git-buildpackage (to build the debian package)
Use git-buildpackage to build from source and follow the usual workflow while developing:
- Edit files
- Commit them with git
- When a new release of the package is ready use
git-dch -Rto update changelog file - Add and commit the debian/changelog file too.
- Use
git-buildpackage --git-signto build the package at specified release and create tag - Push to the remote repository with
git push && git push --tags