Move documentation to RTFD

PaNOSC-ViNYL / SimEx

Start-to-end photon experiment simulation platform

https://simex.readthedocs.io/

GNU General Public License v3.0

26 stars 25 forks source link

Move documentation to RTFD #187

Open CFGrote opened 4 years ago

JunCEEE commented 4 years ago

Hi @CFGrote, the old documentation page was unavailable now, https://eucall-software.github.io/simex_platform/, do we have a new link for our documentation?

CFGrote commented 4 years ago

it's still under github-pages, now here: https://panosc-vinyl.github.io/SimEx/

CFGrote commented 4 years ago

Moving to readthedocs is not that straightforward as initially thought because it's not that simple to instruct RTD how to build SimEx. Building SimEx is needed because sphinx (the documentation engine) tries to import SimEx. If we don't want to build SimEx we would have to mock quite a number of modules which is also quite tedious. So better leave it on gh-pages for now and just update the style?

JunCEEE commented 4 years ago

I agree with the idea to just update the style.