search

schlosser / eventum

An event-driven CMS that syncs with Google Apps
21 stars 15 forks source link

Docstring and Sphinx support #85

Closed schlosser closed 9 years ago

schlosser commented 10 years ago

closes #3

This adds a ton of documentation, as well as support for Sphinx, which compiles documentation to an HTML website.

screen shot 2014-10-10 at 1 56 49 pm

natebrennand commented 10 years ago

that is quite the Makefile

schlosser commented 10 years ago

Generated by Sphinx... should I pair it down?

natebrennand commented 10 years ago

nah, i think it's fine. But anything that's not a configuration file for Sphinx shouldn't be included

schlosser commented 10 years ago

The .rst files are not generated, if that's what you're talking about. Well, they were at a time, but I customized them. From them, an html website is built in the docs/_build/html folder (which is in the .gitignore)

natebrennand commented 10 years ago

ya, I looked through the files and none of them seemed to be generated, was more of a general note. Anything that doesn't match the generated file is fine obviously

schlosser commented 10 years ago

@natebrennand @freeslugs as much as I hate to say it, I think this PR is ready for review....

schlosser commented 9 years ago

I will change to .format() in another PR. Everything else so far has been addressed.

Thanks for taking on this PR Nate! It's a beast.

natebrennand commented 9 years ago

:+1:

No problem, sorry it took me a while to get to it. Was kinda dreading it (rightfully so, it was like 2+ hours)

schlosser commented 9 years ago

Am I :green_apple:?

natebrennand commented 9 years ago

one sec, checking the latest commit

On Wed, Nov 5, 2014 at 12:06 AM, Dan Schlosser notifications@github.com wrote:

Am I [image: :green_apple:]?

— Reply to this email directly or view it on GitHub https://github.com/danrschlosser/eventum/pull/85#issuecomment-61760478.

natebrennand commented 9 years ago

:+1: after the return status code fix