search

AdvancedPhotonSource / xdesign

Tools for designing x-ray phantoms and experiments.
https://xdesign.readthedocs.io
Other
24 stars 16 forks source link

readthedocs.org API reference is broken #31

Closed matze closed 7 years ago

matze commented 7 years ago

FYI: The modules/functions seem to be empty even though they are in fact documented properly. Besides that, a gentle introduction or tutorial would be nice.

dgursoy commented 7 years ago

I guess some dependencies that rely on C need to be mocked on the doc config.

carterbox commented 7 years ago

@matze, if you look into the demos folder, there are some Jupyter notebooks that are pretty well described. As for official introductions, I'll put that on a list.

decarlof commented 7 years ago

@carterbox if you like I can add the Jupyter notebooks in the docs similar to what we did in tomopy

dgursoy commented 7 years ago

I'd open Jupiter notebook addition in a separate thread.

Also the API seems still failing - need to check if all C dependent packages are properly mocked.

decarlof commented 7 years ago

API should work fine after you accept #34 (see my doc built).