Skip to content

Sphinx Documentation #3

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

Open
1 of 2 tasks
michaeljohnbarr opened this issue Jul 24, 2013 · 0 comments
Open
1 of 2 tasks

Sphinx Documentation #3

michaeljohnbarr opened this issue Jul 24, 2013 · 0 comments
Assignees

Comments

@michaeljohnbarr
Copy link
Owner

While the readme.md file gives a basic idea of the project layout, I would prefer to use Sphinx to generate the documentation to the Github Pages based on the docstring of each class/method.

To do so, we will need to create a gh-pages branch, then commit the Sphinx-generated HTML to that branch.

  • Create a gh-pages branch.
  • Update all __docstring__'s within the project to the appropriate format.
@ghost ghost assigned michaeljohnbarr Jul 24, 2013
michaeljohnbarr pushed a commit that referenced this issue Jul 28, 2013
…umentation per Issue #3. Added settings.py to the .gitignore to prevent from accidental commits.
michaeljohnbarr pushed a commit that referenced this issue Aug 2, 2013
…ng, as the module was listed as 'core' instead of 'vdf' - Issue #3.
michaeljohnbarr pushed a commit that referenced this issue Aug 4, 2013
#3). Fixed a bug in URL formatting where the logic allowed appending the '&format=<name>' multiple times. Updated test_core.py to test the content-type returned in the header of the request. This will make sure that we are getting the correct response type for XML, JSON, and VDF requests (Issue #4).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant