Skip to content

An extension to visualize interactive STL files in your Sphinx documentation

Notifications You must be signed in to change notification settings

Peque/sphinxstl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 

Repository files navigation

sphinxstl

An extension to visualize STL files in your Sphinx documentation.

pip install sphinxstl

Usage

Enable the Sphinx extension(s) in your conf.py file:

extensions = [
    '...',
    'sphinxstl.sphinxstl',
]

Then you can use the .. stl:: directive in your documentation:

.. stl:: http://upload.wikimedia.org/wikipedia/commons/9/93/Utah_teapot_%28solid%29.stl

You may want to play with the supported options for a customized look:

.. stl:: http://upload.wikimedia.org/wikipedia/commons/9/93/Utah_teapot_%28solid%29.stl
   :rotation: true
   :color: #ff00ff
   :background: #222222
   :width: 80%
   :height: 200px
   :gridsize: 20.
   :griddivisions: 20

Notes

Thingiview files are taken from `https://github.com/iXce/thingiview.js`__, a fork of `https://github.com/tbuser/thingiview.js`__. See the original project for their respective license (LGPL).

About

An extension to visualize interactive STL files in your Sphinx documentation

Resources

Stars

Watchers

Forks

Packages

No packages published