Documentation Enhancements

[Quantalabs]

Checklist:

• [x] Title is meaningful
• [x] Followed Contributing Guidelines
• [x] No new issues, pre-existing issues in the repo are okay. We just don't want faulty code to be published to the nightly build or main if it can be prevented
• [x] All new dependencies are added to [package.json]

Overview

Adds fully automated documentation generation, with jsdoc-to-markdown, and changed the vuepress theme and added plugins.

File Changelist

• .github/workfows/docs.yml
  • Fix documentation workflow
• EpiJS/comp.js
  • Edit jsdoc comments for better rendering in final documentation output.
• EpiJS/index.js
  • Change package variable to packagejson for JSDoc parsing errors.
• docs/.vuepress/config.js
  • Update configuration to add plugins and themes
• docs/.vuepress/dist/**
  • Rebuild documentation
• docs/.vuepress/styles/index.styl
  • Edit styling for tabs plugin
• docs/.vuepress/styles/pallette.styl
  • Edit progress bar color
• docs/README.md
  • Update landing page
• docs/*.md
  • Rebuild docs using jsdoc-to-markdown
• package.json
  • Update documentation scripts
  • Add vuepress plugins and other packages
• scripts/*
  • Remove previous documentation scripts
  • Add new documentation script with jsdoc-to-markdown

Other Notes

Screenshots:

[codecov[bot]]

Codecov Report

Merging #142 (b0647b1) into main (005a801) will decrease coverage by 0.63%. The diff coverage is 100.00%.

:exclamation: Current head b0647b1 differs from pull request most recent head 2c895d2. Consider uploading reports for the commit 2c895d2 to get more accurate results

@@             Coverage Diff             @@
##              main     #142      +/-   ##
===========================================
- Coverage   100.00%   99.36%   -0.64%     
===========================================
  Files            5        6       +1     
  Lines          453      471      +18     
===========================================
+ Hits           453      468      +15     
- Misses           0        3       +3     

Impacted Files	Coverage Δ
EpiJS/comp.js	100.00% <ø> (ø)
EpiJS/index.js	100.00% <100.00%> (ø)
EpiJS/plots.js	84.21% <0.00%> (-15.79%)	:arrow_down:

---

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 005a801...2c895d2. Read the comment docs.