Copyright (c) 2005-2015 Hibari developers. All rights reserved.
All Hibari docs including the followings are available online at https://hibari.readthedocs.org
-
Hibari Application Developer’s Guide
-
Hibari System Administrator’s Guide
-
Hibari Contributor’s Guide
You can also download the HTML and EPub versions of the docs from the above site.
Hibari docs are hosted at Read the Docs.
If you wish to edit the docs, you might want to build the docs locally on your PC before sending a GitHub pull request. To do that, you need to install Sphinx.
Sphinx is a tool that makes it easy to create beautiful documentation. Assuming you have Python and pip already, install Sphinx:
$ pip install sphinx sphinx-autobuild
You also need the theme provided by Read the Docs.
$ pip install sphinx_rtd_theme
Finally, you need a Sphinx extension called Erlang Domain to render Erlang API document.
$ pip install sphinxcontrib-erlangdomain
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.