search

oslocyclotronlab / ompy_Archive_Sept2019

Archived version om ompy as of 27. Sept 2019 -- Please use this instead:
https://github.com/oslocyclotronlab/ompy/
GNU General Public License v3.0
0 stars 1 forks source link

Workaround for docs: skip include of members from external packages #43

Open fzeiser opened 5 years ago

fzeiser commented 5 years ago

Issue by fzeiser Thursday Sep 26, 2019 at 14:16 GMT Originally opened as https://github.com/oslocyclotronlab/ompy/issues/43

Currently, we only have a workaround to skip including classes, function and variables (constants) from external packages. They are explicitly listed with the :skip: command: https://github.com/oslocyclotronlab/ompy/blob/56f46e23d1e4a688df612e18f8f2c127c8478158/docs/source/API/index.rst#L8-L11

I couldn't figure out how to tell automodsumm, or automodapi, which seems to be responsible for finding all packages, how to not include external packages. It's pretty stupid to have a documentation for scipy's interp1d function in ompy.... It would be nice to have this automated in the future. If we were now to create a interp1d class or function, it would not be listed...