Set up GitHub pages

[Pradeep Reddy Raamana]

Readthedocs.org is unreliable.

Need to set up GitHub pages and use the existing sphinx docs to autogenerate GitHub pages.

[Deleted user]

I am looking for a good (doable, but challenging) first #hacktoberfest issue. I would like to grab this one out.

[Pradeep Reddy Raamana]

Thank you :), appreciate your help.

First, Are you familiar with

• methods to automatically generate documentation, with sphinx?
• methods to set up websites containing that documentation - like readthedocs.io and github pages?

Let's try to discuss this here, and make a plan before you dive into code and hack your way.

[Deleted user]

Sounds great.
I have never written sphinx documentation. But I generated a few things locally, and I did read a little about it for a project before (https://github.com/codeforgoodconf/free-geek). I had to write a script to fix links issue, but I got a good idea how Sphinx work.

I did use gh-pages a lot, but all via Jekyll.

I did google for help and found this: https://daler.github.io/sphinxdoc-test/includeme.html and this http://nikhilism.com/post/2012/automatic-github-pages-generation-from/. I thought I could try to set it up.

[Pradeep Reddy Raamana]

Thanks for elaborating on this. Please go ahead, fork it and try something locally, and let me know how it goes.