hwdocer 0.2.2

Wireviz, drawio and other documentation build tool

HWDOCER

The HardWare DOCumentation buildER is a utility that help generating graphical documentations using drawio and wireviz

Install

Stable version

Stable package are release on pypi.org and are installable simply via pip:

pip install hwdocer

You can also clone the specific tags from the repo

Development version

Development version are only available on the repo, the suggested process is to add a git submodule to your project:

1. Add the submodule
   simply open a terminal in the host repo and execute this:

   git submodule add https://gitlab.com/real-ee/public/hwdocer.git dep/hwdocer
   

2. Venv install Then you need to install the venv, by having poetry and pyenv.
   Open a terminal then execute this:

   poetry install
   

Usage

Direct call

If you installed the stable version (via pypi) you can call it directly like this:

hwdocer -vv -i "./" -o "./_build"

Python module call

When installed as a python module, you can invoke it

poetry run python -m hwdocer -vvvv -i "./doc" -o "./doc/build"

NOTE: Currently all *.yml file in the input search will match for harness drawing and all *.drawio files will match for diagram drawing

Adding source to be built

This tool uses drawio local software and wireviz defined file, use them to creat some source file which you pass as input (-i argument) to hwdocer.

Drawio

To create diagram and drawing that will be then automatically drawn by this tool, you need to install drawio local executable by downloading the installer for your OS (only linux tested)

Wireviz

To create wire harness, install wireviz, which is a project based on graphviz but aimed to specifically draw wire harnesses.

Contrib

See the contribution guideline

Changelog

See the release file and roadmap file

License

This software is released under GPL3