search

raamana / pyradigm

Research data management in biomedical and machine learning applications
http://raamana.github.io/pyradigm/
MIT License
28 stars 12 forks source link

Setup GitHub pages #9

Open raamana opened 7 years ago

raamana commented 7 years ago

Read the docs is not reliable to auto generating docs and site

morganhoward commented 7 years ago

Hi. I'm interested in working on this. Do you have any specs in mind?

I took a quick look at the GitHub pages documentation and it looks like the docs (.rst) would need to be converted to markdown and then the GitHub page(s) could be configured for the project. Is that in line with what you were looking for?

raamana commented 7 years ago

Thanks Morgan. I don't have anything very particular in mind - just that: 1) the docs auto-generated for every push, reliably 2) theme being easy to read and follow - both on desktop and on mobile (RTD theme is pretty good in that sense, if it worked)

I don't know the specs for gh-pages, so do whatever you need to get it working.