search

FXIhub / hummingbird

Monitoring and Analysing flash X-ray imaging experiments
http://fxihub.github.io/hummingbird
BSD 2-Clause "Simplified" License
16 stars 14 forks source link

Make example docs dependent on python files #88

Closed daurer closed 8 years ago

daurer commented 8 years ago

It should be possible to have the documentation of the examples to be dependent on the actual example files. This avoids out-dated example docs and ugly copy-pasting.

mhantke commented 8 years ago

Use for example:

.. literalinclude:: ../examples/scripts/simple/example.py :language: python

On Mon, Jul 18, 2016 at 4:11 PM, Benedikt Daurer notifications@github.com wrote:

It should be possible to have the documentation of the examples to be dependent on the actual example files. This avoids out-dated example docs and ugly copy-pasting.

b

Max Felix Hantke Ph.D. student Laboratory of Molecular Biophysics Uppsala University

www.lmb.icm.uu.se

daurer commented 8 years ago

Thanks, this is exactly what I was looking for.