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.

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

Merged
merged 19 commits into from
Jan 30, 2018
Merged

Docs refactor #558

merged 19 commits into from
Jan 30, 2018

Conversation

Blendify
Copy link
Member

Fix #557 see individual commits for details

@Blendify Blendify added the PR: work in progress Pull request is not ready for full review label Jan 25, 2018
@Blendify Blendify added Priority: high High priority PR: ready for review Improvement Minor improvement to code and removed PR: work in progress Pull request is not ready for full review labels Jan 29, 2018
@ericholscher
Copy link
Member

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)

@ericholscher
Copy link
Member

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.

@Blendify
Copy link
Member Author

@ericholscher

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)

What do you mean exactly about the title in the sidebar? Do you want all these docs under one collapsible heading?

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 by real info? What about including the readme file before the toctree?

@ericholscher
Copy link
Member

  • Remove the "Read the Docs Sphinx Theme" , or the logo, from the sidebar. It looks weird with both.

  • Including the readme above the TOC would be a good start. That way we only have that info in one place.

Also, remove documentation of theme options. We have actual docs for this.
@Blendify
Copy link
Member Author

Addressed the review points. It looks really good now. So glad I got around to this. BTW with the PR #535 becomes obsolete.

Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great. 👍

@Blendify Blendify merged commit 67bb54d into master Jan 30, 2018
@Blendify Blendify deleted the docs-refactor branch January 30, 2018 01:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Minor improvement to code Priority: high High priority
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants