sphinxcontrib-eagle is a Sphinx extension exports eagle partlist or image (2D/3D) of schematic or board during the build step and includes them into the documentation.
Links:
- home: https://github.com/ponty/sphinxcontrib-eagle
- documentation: http://ponty.github.com/sphinxcontrib-eagle
Features:
- eagexp is used for processing
Basic usage
.. eagle-image:: singlesided.sch
:resolution: 100
:scale: 30 %
.. eagle-image3d:: singlesided.brd
.. eagle-partlist:: singlesided.sch
:header: part, value
How it works
1. export image or text by eagle using eagexp
2. include image or text into documentation
Installation
General
- install eagle
- install povray (optional for 3D)
- install pip
- install pyvirtualdisplay , xvfb , xephyr (optional for background processing)
- install the program:
# as root
pip install sphinxcontrib-eagle
Ubuntu
sudo apt-get install eagle
sudo apt-get install povray
sudo apt-get install python-pip
# optional for background processing
sudo apt-get install xvfb xserver-xephyr
sudo pip install sphinxcontrib-eagle
Uninstall
# as root
pip uninstall sphinxcontrib-eagle
Requirements:
- Python
- Sphinx
Comments not found