initc3 / HoneyBadgerMPC

Robust MPC-based confidentiality layer for blockchains

GNU General Public License v3.0

131 stars 64 forks source link

Documentation/bugs/438 #441

Closed sbellem closed 4 years ago

sbellem commented 4 years ago

Fixes #438 and #440.

Removed some outdated docs with respect to the internals and updated a tiny bit what is documented for the internals, just pulling docstrings from some modules with autodoc.
Switch from m2r to recommonmark for using markdown with Sphinx (restructuredText).
Use an absolute path for the location of the benchmark logs directory to prevent a file not found error when docs are built, as the benchmark logs dir was then looked up under the docs/ folder as the config was using a relative path.

codecov[bot] commented 4 years ago

Codecov Report

Merging #441 into dev will decrease coverage by 0.08952%. The diff coverage is n/a.

@@                 Coverage Diff                 @@
##                 dev        #441         +/-   ##
===================================================
- Coverage   77.27842%   77.18890%   -0.08952%     
===================================================
  Files             50          50                 
  Lines           5585        5585                 
  Branches         856         856                 
===================================================
- Hits            4316        4311          -5     
- Misses          1095        1098          +3     
- Partials         174         176          +2