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

Port Docs to `.rst` #2016

Merged
merged 5 commits into from Feb 15, 2017

Conversation

Projects
None yet
4 participants
@fosskers
Contributor

fosskers commented Feb 14, 2017

TODO

  • Mass conversion via pandoc
  • Fix markup errors
  • Enable nested TOCs
  • Test fix for #1967

Motivation

#1967 . It turns out that RTD search just doesn't work for projects based on mkdocs, which we currently are.

(docs) md -> rst [skip ci]
- This gives us nested TOCs for easier navigation
- This should also fix #1967

@fosskers fosskers force-pushed the docs/port-to-rst branch from 2861711 to 8d6e8ab Feb 14, 2017

@fosskers fosskers force-pushed the docs/port-to-rst branch from e1faf16 to aef2757 Feb 14, 2017

@fosskers fosskers removed the in progress label Feb 14, 2017

@fosskers fosskers changed the title from Port Docs to `.rst` to [WIP] Port Docs to `.rst` Feb 14, 2017

@fosskers fosskers changed the title from [WIP] Port Docs to `.rst` to Port Docs to `.rst` Feb 14, 2017

@echeipesh echeipesh merged commit e2d7bb1 into master Feb 15, 2017

@fosskers

This comment has been minimized.

Contributor

fosskers commented Feb 15, 2017

RTD latest now points to this repo's master again, as it originally did. Being able to point latest at different branches is handy for testing. The setting ("default branch") can be found under Advanced Settings in RTD's Admin panel.

@fosskers fosskers deleted the docs/port-to-rst branch Feb 15, 2017

@lossyrob lossyrob added this to the 1.1 milestone Mar 12, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment