Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Setup GitHub pages #9

Open
raamana opened this issue Sep 28, 2017 · 2 comments
Open

Setup GitHub pages #9

raamana opened this issue Sep 28, 2017 · 2 comments

Comments

@raamana
Copy link
Owner

raamana commented Sep 28, 2017 •
edited

Read the docs is not reliable to auto generating docs and site
@morganhoward
Copy link

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
Copy link
Owner Author

raamana commented Sep 28, 2017 •
edited

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@raamana @morganhoward