pyradigm icon indicating copy to clipboard operation
pyradigm copied to clipboard

Published 20 hours ago • verified publisher icon raamana

Setup GitHub pages

Open raamana opened this issue 8 years ago • 2 comments
trafficstars

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

raamana avatar Sep 28 '17 01:09 raamana

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?

morganhoward avatar Sep 28 '17 03:09 morganhoward

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.

raamana avatar Sep 28 '17 12:09 raamana