Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Create documentation with sphinx #248
@@ Coverage Diff @@ ## master #248 +/- ## ======================================= Coverage 88.76% 88.76% ======================================= Files 13 13 Lines 1477 1477 Branches 267 267 ======================================= Hits 1311 1311 Misses 108 108 Partials 58 58
How about the structure used in http://sphinx-rtd-theme.readthedocs.io/en/latest/index.html and https://raw.githubusercontent.com/rtfd/sphinx_rtd_theme/master/docs/index.rst?
If i include the README.rst as it is now, the paths to the images do not work and the toc structure is not very nice.
Hmm, that's a difficult problem. I would strongly prefer to keep the README useful without having to follow external links.
Perhaps an alternative would be to move the documentation directory to the root directory? If the
I would keep the documentation in the docs folder. Otherwise the sphinx files, makefile etc would be in the same folder as non-doc stuff.
Maybe we can include snippets from the main README.rst in the doc/source/index.rst file, like in the guide.rst file:
This way we would reduce copy-and-paste an little bit and can setup a documentation structure freely for sphinx.
See the last commit e0efb49.
I'm now reviewing this PR so that I can merge it – sorry for the delay, I've been very busy.
I think the new documentation looks absolutely fantastic, and I'm looking forward to replacing the homepage :)
Below, I've gathered a few review comments. The first bunch is about the Sphinx configuration, the rest about the structure and organization of the docs.
I'd be super glad if you could tackle these suggestions. In any case, I'll try to merge within a week.