abraflexi-api-doc

A standalone, Sphinx-built reference guide for the AbraFlexi (FlexiBee) REST API itself — not any particular client library. Compiled and translated from the official documentation at podpora.flexibee.eu and cross-checked against the reference PHP AbraFlexi library. Examples throughout use JSON.

Available in two languages, each producing its own Debian package:

• cs/ → abraflexi-api-doc-cs (Czech)
• en/ → abraflexi-api-doc-en (English)

Building the HTML docs

pip install sphinx shibuya   # or: apt install python3-sphinx python3-shibuya-sphinx-theme
sphinx-build -b html cs cs/_build
sphinx-build -b html en en/_build

Building the Debian packages

dpkg-buildpackage -us -uc -b

Produces abraflexi-api-doc-cs and abraflexi-api-doc-en, each installing its HTML output to /usr/share/doc/abraflexi-api-doc-{cs,en}/html, with an Apache2 config snippet enabled automatically and an Nginx snippet provided for reference. CI builds and test-installs both packages across several Debian/Ubuntu releases — see debian/Jenkinsfile.

Testing

./tests/test_docs_build.sh

Builds both cs/ and en/ with Sphinx's -W flag (warnings become errors, catching broken toctrees/references and malformed tables) and verifies both language trees have the same number of chapters, so a new chapter added in one language isn't silently forgotten in the other.

Related projects

• php-abraflexi — PHP client library for the AbraFlexi REST API
• python-abraflexi — Python client library for the AbraFlexi REST API

License

MIT — see LICENSE. Note the underlying factual API description originates from ABRA Software's own FlexiBee documentation; this project is an independent compiled/translated reference, not an official ABRA Software publication.