initc3 / HoneyBadgerMPC

Robust MPC-based confidentiality layer for blockchains
GNU General Public License v3.0
128 stars 64 forks source link

Improve the documentation generation workflow #449

Closed sbellem closed 4 years ago

sbellem commented 4 years ago

Re-work the documentation workflow to use the Makefile and docker-compose to ease the documentation generation.

Basically, all that should be needed is to run

$ make servedocs

which will

The documentation on how to generate the documentation was also updated to reflect these changes. A preview can be seen at https://101-141841687-gh.circle-artifacts.com/0/docs/development/getting-started.html#building-and-viewing-the-documentation.

codecov[bot] commented 4 years ago

Codecov Report

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

@@                 Coverage Diff                 @@
##                 dev        #449         +/-   ##
===================================================
- Coverage   77.31423%   77.24261%   -0.07162%     
===================================================
  Files             50          50                 
  Lines           5585        5585                 
  Branches         856         856                 
===================================================
- Hits            4318        4314          -4     
- Misses          1094        1096          +2     
- Partials         173         175          +2