MkDocs - Building the REST framework documentation generator into a standalone project.

1,478 views
Skip to first unread message

Tom Christie

unread,
Jan 21, 2014, 3:37:12 PM1/21/14
to django-res...@googlegroups.com
Hey folks,

I've started extracting the Django REST framework documentation building script into a standalone project, named MkDocs.

The intention is that this will become the tool that we use to build the Django REST framework docs with, instead of the current hacky script, and also be usable by other projects for building documentation from markdown source files.

You can see the initial mocked-up docs for the project here: www.mkdocs.org and checkout the github repo here: https://github.com/tomchristie/mkdocs

I'm super excited about the project, it's looking pretty great already, can build into both bootstrap and readthedocs styles, and I personally think there's a real need for a nicely done markdown docs builder.

If anyone else is excited about the project and would like to help out please do shout out - there's stacks of potential here and it'd be great to get a collaborative little team going around it.

Cheers folks!

  Tom

Rodrigo Gadea

unread,
Jan 21, 2014, 3:38:53 PM1/21/14
to django-res...@googlegroups.com
I'm in!


--
You received this message because you are subscribed to the Google Groups "Django REST framework" group.
To unsubscribe from this group and stop receiving emails from it, send an email to django-rest-fram...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

Tom Christie

unread,
Jan 21, 2014, 4:05:39 PM1/21/14
to django-res...@googlegroups.com
That was quick!
Great - I'll spend some time pulling the issue list into shape tomorrow so that we're in a position to just get nailing tickets one by one.
I'm in!


To unsubscribe from this group and stop receiving emails from it, send an email to django-rest-framework+unsub...@googlegroups.com.

Rodrigo Gadea

unread,
Jan 21, 2014, 4:09:45 PM1/21/14
to django-res...@googlegroups.com
Excellent!


To unsubscribe from this group and stop receiving emails from it, send an email to django-rest-fram...@googlegroups.com.

fle...@fletchowns.net

unread,
Jan 23, 2014, 2:32:04 PM1/23/14
to django-res...@googlegroups.com
This looks really cool! Nice work and thanks for making this available to everybody!

AK Adapa

unread,
Jun 23, 2014, 8:11:55 PM6/23/14
to django-res...@googlegroups.com
Just tried the mkdocs and it was breeze to get going. Use sphinx-doc for documentation and was looking for something with python for markdown and like it.

Thanks for your efforts.

Juancho Saravia

unread,
Jul 11, 2014, 11:12:54 AM7/11/14
to django-res...@googlegroups.com
Looks great!! Thanks for this excellent project!
Reply all
Reply to author
Forward
0 new messages