Skip to main content

Sphinx extension to include image or partlist of eagle schematic or board

Project description

This Sphinx 1.0 extension exports eagle partlist or image (2D/3D) of schematic or board during the build step and includes them into the documentation.

Links:
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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinxcontrib-eagle-0.0.9.tar.gz (8.1 kB view details)

Uploaded Source

File details

Details for the file sphinxcontrib-eagle-0.0.9.tar.gz.

File metadata

File hashes

Hashes for sphinxcontrib-eagle-0.0.9.tar.gz
Algorithm Hash digest
SHA256 05b6cbe6eb10a003c0d261dd5e2f7f073331f75b66e70df94f910aafa2bd8916
MD5 2326d232badd005fa4b19c1a88521ca0
BLAKE2b-256 6d258d4497056e15437debd2bd648dcc229a1977f992f4fb1dc456a82d7094c7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page