valiot / pygqlc

Python GraphQL Client - PyGQLC

MIT License

12 stars 4 forks source link

Adding general documentation #7

Closed Poetickz closed 4 years ago

Poetickz commented 4 years ago

Description

Adds docstring documentation to all public methods.
Adds html documentation with sphinx.

auto-doc

Type of change

Please delete options that are not relevant.

[X] New feature (non-breaking change which adds functionality)

How Has This Been Tested?

Runned pytest

You can see html documentation running:

$ cd docs
$ make html
$ firefox _build/html/index.html

Checklist:

[x] My code follows the style guidelines of this project
[x] I have performed a self-review of my own code
[x] I have commented my code, particularly in hard-to-understand areas
[x] I have made corresponding changes to the documentation
[x] My changes generate no new warnings
[x] I have added tests that prove my fix is effective or that my feature works
[x] New and existing unit tests pass locally with my changes
[x] Any dependent changes have been merged and published in downstream modules