search

samoylv / WPG

WPG: WavePropaGator, Interactive framework for X-ray FEL optics design and simulations.
Other
26 stars 20 forks source link

utuility function are missing in docs ? #106

Closed samoylv closed 7 years ago

samoylv commented 7 years ago

@buzmakov: how to add modules wpguti*.py in WPG docs?

buzmakov commented 7 years ago

One should create file for each wpguti*.py like https://raw.githubusercontent.com/samoylv/WPG/develop/docs/optical_elements.rst and add reference in https://raw.githubusercontent.com/samoylv/WPG/develop/docs/index.rst

samoylv commented 7 years ago

1) I see, it is not generated automatically. BTW in optical elements rst-file some available optical elements are not listed. Does it mean that they should be updated? 2) only one recvord should be in every file (see below), then all the functions in the file will be included? :mod:wpg.wpg_uti_wf module

.. automodule::wpg.wpg_uti_wf :members: :undoc-members: :show-inheritance:

buzmakov commented 7 years ago

1) I add aliases to SRW optical elements manually ( I don't remember why, but it work) 2) I think yes. I don't remember exactly.

samoylv commented 7 years ago

implemented in 5921a0852aecff278e3d1a6eff62cab16901cf92