nklapste commented 5 years ago

Adding some sphinx documentation to the project.

Misc cleanup and improvement of graypy's documentation.

codecov-io commented 5 years ago

Codecov Report

Merging #100 into master will not change coverage. The diff coverage is 100%.

@@           Coverage Diff           @@
##           master     #100   +/-   ##
=======================================
  Coverage   94.69%   94.69%           
=======================================
  Files           3        3           
  Lines         226      226           
=======================================
  Hits          214      214           
  Misses         12       12

Impacted Files	Coverage Δ
graypy/handler.py	`98.75% <ø> (ø)`	:arrow_up:
graypy/__init__.py	`71.42% <ø> (ø)`	:arrow_up:
graypy/rabbitmq.py	`86.2% <100%> (ø)`	:arrow_up:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 5766c9a...d5b8338. Read the comment docs.

severb commented 5 years ago

I was under the impression that we already merged this and your other outstanding diffs. Should I take a look at the changes and merge them all in?

nklapste commented 5 years ago

This is mainly a update and amendment of past docs.

This also adds sphinx documentation generation. But, its actual build on readthedocs is untested, last time I checked graypy does indeed have a readthedocs endpoint, but, I have no access to such.

Any review would be welcome @severb! If any of the docs seem confusing or contrived please let me know.

severb commented 5 years ago

I added you as a maintainer on RTD. The changes LGTM, please feel free to push them whenever you feel like it.

severb / graypy

Feature/sphinx docs #100

Codecov Report