upsidedownlabs / BioAmp-EXG-Pill

BioAmp EXG Pill is a small and elegant Analog Front End (AFE) board for BioPotential signal acquisition.
https://www.crowdsupply.com/upside-down-labs/bioamp-exg-pill
Other
265 stars 63 forks source link

Sphinx Documentation #25

Closed KhanFiza896 closed 2 years ago

KhanFiza896 commented 2 years ago

Hey @lorforlinux I have made new documentation site for BioAmp-EXG-Pill using 'sphinx documentation'. The Files i have added in docs/sphinx folder are as follows:

  1. Created introduction, applications, software, and hardware folders which contains index.rst files (An RST file is a text file that contains code written in the reStructuredText markup language).
  2. Added restructured code for BioAmp-EXG-Pill inside the index.rst files.
  3. Created .gitignore file to ignore docs/ _build/ folder.
  4. Created VERSION file to display latest version of BioAmp-EXG-Pill on main page.

Still there is more work which have to be done. for example,

  1. auto generated pdf using sphinx.
  2. auto built documentation using github pages.
  3. multiple versions display option.
  4. light and dark theme toggler button.
lorforlinux commented 2 years ago

Thanks for this awesome update @KhanFiza896.