Merge pull request #148 from CohenLabPrinceton/docs_hardware

Docs hardware

.gitignore

@@ -22,3 +22,14 @@ dist
 *.svg
 
 sandbox/Untitled.ipynb
+/_docs/assets/cad/PEEP-expiratory-valve/
+/_docs/assets/DXFs/
+/_docs/assets/pcbs/
+/_docs/assets/solidworks/
+/_docs/assets/STLs/
+/_docs/assets/README.md
+/docs/cad/PEEP-expiratory-valve/
+/docs/DXFs/
+/docs/pcbs/
+/docs/solidworks/
+/docs/STLs/

.readthedocs.yaml

@@ -0,0 +1,32 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.9"
+    # You can also specify other tool versions:
+    # nodejs: "16"
+    # rust: "1.55"
+    # golang: "1.17"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: _docs/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+formats:
+    - pdf
+    - epub
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+     - requirements: requirements_docs.txt
+     - method: pip
+       path: .

.travis.yml

@@ -27,14 +27,8 @@ env:
 
 install:
   - pip install -U pip
-  - pip install -U pytest
-  - pip install -U pytest-cov
-  - pip install -U pylint
-  - pip install -U coveralls
-  - pip install -U numpy~=1.18.4
-  - pip install -U PySide2==5.11.*
-  - pip install -U pyqtgraph>=0.11.0rc0
-  - pip install -U scipy~=1.4.1
+  - pip install -r requirements.txt
+  - pip install -r requirements_tests.txt
   - pip install -e .
   - "/sbin/start-stop-daemon --start --quiet --pidfile /tmp/custom_xvfb_99.pid --make-pidfile --background --exec /usr/bin/Xvfb -- :99 -screen 0 1920x1200x24 -ac +extension GLX +render -noreset"
   - sleep 3

_docs/conf.py

@@ -13,10 +13,23 @@
 import os
 import sys
 import mock
+from pathlib import Path
+import shutil
 sys.path.insert(0, os.path.abspath('..'))
 sys.path.insert(0, os.path.abspath('../pvp'))
 sys.path.insert(0, os.path.abspath('.'))
 
+# copy hardware assets at build time
+root_assets = Path('../assets').resolve()
+docs_assets = Path('./assets').resolve()
+for asset_file in root_assets.glob('**/*'):
+    if asset_file.is_dir():
+        continue
+    new_file = docs_assets / asset_file.relative_to(root_assets)
+    new_file.parent.mkdir(parents=True, exist_ok=True)
+    shutil.copy(str(asset_file), str(new_file))
+
+
 sys.modules['Shiboken'] = mock.Mock()
 sys.modules['PySide2.QtMultimedia'] = mock.Mock()
 
@@ -50,7 +63,7 @@
     # 'sphinx_automodapi.automodapi',
     'sphinxcontrib.napoleon', # parse google style docstrings
     'autodocsumm',
-    'recommonmark',   # support markdown
+    'myst_parser',   # support markdown
     'sphinx_sass' # support sass/scss
 ]