-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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.
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
Docs refactor #558
Docs refactor #558
Conversation
The rest gets pointed to our actual docs
I'd like to see more copy on the docs index page, not just a TOC. Also would be good to figure out how to stop the title from displaying in the sidebar (eg. http://sphinx-rtd-theme.readthedocs.io/en/docs-refactor/installing.html) |
Big +1 on splitting up the content into multiple pages though. This makes a lot of sense, just needs a bit more cleanup on the landing page. I don't want to make people click GitHub -> RTD -> TOC to get any real info. |
What do you mean exactly about the title in the sidebar? Do you want all these docs under one collapsible heading?
What do you mean by real info? What about including the readme file before the toctree? |
|
Also, remove documentation of theme options. We have actual docs for this.
Addressed the review points. It looks really good now. So glad I got around to this. BTW with the PR #535 becomes obsolete. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great. 👍
Fix #557 see individual commits for details