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

README sections not in sidebar #523

Closed
jessetan opened this issue Dec 22, 2017 · 1 comment
Closed

README sections not in sidebar #523

jessetan opened this issue Dec 22, 2017 · 1 comment

Comments

@jessetan
Copy link
Contributor

Since #520, the README is part of the built documentation, but the headers in README do not appear in the sidebar at http://sphinx-rtd-theme.readthedocs.io/en/latest/index.html.
@jessetan jessetan mentioned this issue Dec 29, 2017
Closed
Blendify added a commit that referenced this issue Jan 30, 2018
@Blendify
Refactor docs: split up & slim down read me
67bb54d 
Fixes #557 #523

* Remove old conf file setup

* Split changelog to its ownfile

* Remove changelog from readme

* Update introduction sentence

* Fix wording of intro

* Remove readme table of contents

* Move links to there sections

* Remove config

* Create configuring.rst

* Remove todo

* Remove installing docs from readme

* Create installing.rst

* Remove contributing section from readme

* Create contributing.rst

* Include basic info in readme

The rest gets pointed to our actual docs

* Add new files to toctree

* Fix configuring options title

* Set logo_only to True

  Also, remove documentation of theme options. We have actual docs for this.

* Include readme on index page
@Blendify
Copy link
Member

Fixed in 67bb54d

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
@jessetan @Blendify