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

Consider migrating our developer documentation to Sphinx #1301

Closed
toolness opened this Issue Jan 31, 2017 · 1 comment

Comments

Projects
None yet
3 participants
@toolness
Contributor

toolness commented Jan 31, 2017

Our developer docs are getting kinda big. Aside from our already-big README.md, we've got a variety of other markdown files in our root directory, some of which (I'm looking at you, updating_data.md) might not be fully up-to-date.

It might be worth it to actually consider migrating our docs to use Sphinx, which is the military-grade solution that cg-django-uaa uses. Aside from producing really pretty docs, it makes it a lot easier to create docs that consist of multiple different pages with nice tables of contents linking them together, and a built-in search UI. It also supports markdown, so we wouldn't need to convert all our stuff to reStRuCtuReDTeXt or whatever.

Anyhow, just a thought.

@jseppi

This comment has been minimized.

Contributor

jseppi commented Jan 31, 2017

heh, yeah, not a bad idea

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