/sphinx-bitutils

A Sphinx extension that adds useful utilities for describing bitwise and bytewise structures

Primary LanguagePythonBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

sphinx-bitutils

Warning This sphinx extension is still very much in beta! It might (read, will) break randomly.

This is a sphinx addon that adds utilities to describe bitwise and bytewise binary structures in Sphinx without the need to resort to tables.

There is also support for Construct objects to be automatically documented using the same utilities to provide a consistent and pretty look.

Installation

License

sphinx-bitutils is licensed under the BSD 3 Clause, the full text of which can be found in the LICENSE file.