added Sphinx workflows

glasgowlab · Aug 5, 2024 · 30e9e1c · 30e9e1c
1 parent 4197afd
commit 30e9e1c
Show file tree

Hide file tree

Showing 10 changed files with 32 additions and 6 deletions.
diff --git a/.github/workflows/sphinx.yml b/.github/workflows/sphinx.yml
@@ -0,0 +1,24 @@
+name: "Sphinx: Render docs"
+
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+    - uses: actions/checkout@v4
+    - name: Build HTML
+      uses: ammaraskar/sphinx-action@master
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: html-docs
+        path: docs/build/html/
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v3
+      if: github.ref == 'refs/heads/main'
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: docs/build/html
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/nbsphinx/tutorials/01_load_data.ipynb b/docs/build/doctrees/nbsphinx/tutorials/01_load_data.ipynb
@@ -11,7 +11,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "In principle, FEATHER can accept the output from any HDS/MS software. Currently, it only supports the output from HDExaminer. Future versions will include support for other common software, such as HDX Workbench.\n",
+    "In principle, FEATHER can accept the output from any HX/MS software. \n",
     "\n",
     "There are two types of input files:\n",
     "1. Peptide pools with centroid deuteration values\n",

diff --git a/docs/build/doctrees/tutorials/01_load_data.doctree b/docs/build/doctrees/tutorials/01_load_data.doctree
diff --git a/docs/build/html/_sources/tutorials/01_load_data.ipynb.txt b/docs/build/html/_sources/tutorials/01_load_data.ipynb.txt
@@ -11,7 +11,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "In principle, FEATHER can accept the output from any HDS/MS software. Currently, it only supports the output from HDExaminer. Future versions will include support for other common software, such as HDX Workbench.\n",
+    "In principle, FEATHER can accept the output from any HX/MS software. \n",
     "\n",
     "There are two types of input files:\n",
     "1. Peptide pools with centroid deuteration values\n",

diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js
diff --git a/docs/build/html/tutorials/01_load_data.html b/docs/build/html/tutorials/01_load_data.html
@@ -96,7 +96,7 @@
 
   <section id="01_load_data">
 <h1>01_load_data<a class="headerlink" href="#01_load_data" title="Link to this heading"></a></h1>
-<p>In principle, FEATHER can accept the output from any HDS/MS software. Currently, it only supports the output from HDExaminer. Future versions will include support for other common software, such as HDX Workbench.</p>
+<p>In principle, FEATHER can accept the output from any HX/MS software.</p>
 <p>There are two types of input files: 1. Peptide pools with centroid deuteration values 2. Raw mass spectra (deconvoluted)</p>
 <section id="Read-the-centroid-data">
 <h2>Read the centroid data<a class="headerlink" href="#Read-the-centroid-data" title="Link to this heading"></a></h2>

diff --git a/docs/build/html/tutorials/01_load_data.ipynb b/docs/build/html/tutorials/01_load_data.ipynb
@@ -11,7 +11,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "In principle, FEATHER can accept the output from any HDS/MS software. Currently, it only supports the output from HDExaminer. Future versions will include support for other common software, such as HDX Workbench.\n",
+    "In principle, FEATHER can accept the output from any HX/MS software. \n",
     "\n",
     "There are two types of input files:\n",
     "1. Peptide pools with centroid deuteration values\n",

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,2 @@
+furo==2021.11.16
+nbsphinx=0.9.3
diff --git a/docs/source/tutorials/01_load_data.ipynb b/docs/source/tutorials/01_load_data.ipynb
@@ -11,7 +11,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "In principle, FEATHER can accept the output from any HDS/MS software. Currently, it only supports the output from HDExaminer. Future versions will include support for other common software, such as HDX Workbench.\n",
+    "In principle, FEATHER can accept the output from any HX/MS software. \n",
     "\n",
     "There are two types of input files:\n",
     "1. Peptide pools with centroid deuteration values\n",