some tweaks to build docs and pass linting

jbloomlab · Aug 25, 2024 · 69dfcd1 · 69dfcd1
1 parent 114e25a
commit 69dfcd1
Show file tree

Hide file tree

Showing 4 changed files with 1,418 additions and 53 deletions.
diff --git a/docs/README.rst b/docs/README.rst
@@ -10,7 +10,11 @@ Build the documentation
 To build the documentation, you need ensure that you have installed the packages in `doc_requirements.txt <doc_requirements.txt>`_.
 If these packages are not installed, you can install them with::
 
-    pip -r doc_requirements.txt
+    pip install -r doc_requirements.txt
+
+You also may need to install ``pandoc``:
+
+    mamba install pandoc
 
 Then simply type::
 

diff --git a/docs/doc_requirements.txt b/docs/doc_requirements.txt
@@ -1,8 +1,8 @@
-sphinx>=2.0
-sphinx-argparse>=0.2.5
-sphinx_gallery>=0.3.1
-matplotlib>=3.0.2
-nbsphinx>=0.4.2
-nbsphinx-link>=1.2.0
-ipykernel>=5.1.0
-pandoc>=2.7.3
+sphinx
+sphinx-argparse
+sphinx_gallery
+matplotlib
+nbsphinx
+nbsphinx-link
+ipykernel
+pandoc
diff --git a/notebooks/flu_virus_seq_example.ipynb b/notebooks/flu_virus_seq_example.ipynb
diff --git a/ruff.toml b/ruff.toml
@@ -9,6 +9,8 @@ extend-exclude = [
     "dist",
     "docs/_build",
     ".*",
+    "notebooks",
+    "tests",
 ]
 lint.ignore = [
     "D203",