search

amiller / HoneyBadgerBFT

The Honey Badger of BFT Protocols
Other
314 stars 84 forks source link

Sphinx-based documentation boiler plate #22

Closed sbellem closed 7 years ago

sbellem commented 7 years ago

TODO before this can be merged

This pull request proposes to add the necessary boilerplate to build documentation using Sphinx.

A matrix row in Travis CI is also added to test the documentation building step.

codecov-io commented 7 years ago

Codecov Report

Merging #22 into dev will increase coverage by 0.95%. The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##              dev      #22      +/-   ##
==========================================
+ Coverage   58.96%   59.91%   +0.95%     
==========================================
  Files          18       18              
  Lines         943      943              
==========================================
+ Hits          556      565       +9     
+ Misses        387      378       -9
Impacted Files Coverage Δ
honeybadgerbft/core/binaryagreement.py 83.11% <0%> (-5.2%) :arrow_down:
honeybadgerbft/core/commoncoin.py 94.87% <0%> (-2.57%) :arrow_down:
honeybadgerbft/core/honeybadger.py 85.57% <0%> (-0.97%) :arrow_down:
honeybadgerbft/core/commonsubset.py 90.32% <0%> (ø) :arrow_up:
honeybadgerbft/core/reliablebroadcast.py 81.29% <0%> (+10.79%) :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 cb69dbd...2fcefb0. Read the comment docs.