Wireviz, drawio and other documentation build tool
Project description
HWDOCER
The HardWare DOCumentation buildER is a utility that help generating graphical documentations using drawio and wireviz
Install
Via PyPI
TODO
As a Git submodule
-
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
-
Venv install Then you need to install the venv, by having poetry and pyenv.
Open a terminal then execute this:poetry install
Usage
Typically you should add the git repo as a git module so you have a copy locally in your project then simply run it on your doc folder
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
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
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.