Docs (#168)

maxplanck-ie · Jan 10, 2024 · 5fe31ff · 5fe31ff
2 parents 7ed7faa + d24fb05
commit 5fe31ff
Show file tree

Hide file tree

Showing 6 changed files with 37 additions and 2 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -24,4 +24,5 @@ jobs:
         run: |
           micromamba activate dissectBCL
           cd docs
+          pip install -r requirements.txt
           make html
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
diff --git a/AUTHORS b/AUTHORS
@@ -1,6 +1,7 @@
 A.s <62971995+adRn-s@users.noreply.github.com>
 David Koppstein <koppstein@ie-freiburg.mpg.de>
 FerallOut <49016186+FerallOut@users.noreply.github.com>
+Juan Caballero <caballero@pc398.ie-freiburg.mpg.de>
 Katarzyna Sikora <katsikora@users.noreply.github.com>
 Ward D <ward@deboutte.be>
 Ward Deboutte <deboutte@minimus.ie-freiburg.mpg.de>

diff --git a/ChangeLog b/ChangeLog
@@ -1,8 +1,41 @@
 CHANGES
 =======
 
+* include authors
+* make sure doc pytest includes reqs from the doc folder
+* init readthedocs yaml, split up doc requirements
+* seq\_data dirs & docs (#166)
+* Allow new seq dirs when older are not full yet. (#165)
+* Allow new seq dirs when older are not full yet
+* adding documentation for certificate change problems (#162)
+* Main (#164)
+* force listing of PIdirs to be sorted (#163)
+* force listing of PIdirs to be sorted
+* Update usage.rst
+* updating certificate issue
+* adding documentation for certificate change problems
+
+v0.2.6
+------
+
+* Main (#159)
+* Dev wd (#158)
+* include 20 in comment as well
+* miseq reqdepth override to 20
+* flake
+* move reqdepth change in classes due to parkour returning everything
+* santize sample names (space in names)
+* software version to debug log in main func
+* Main (#157)
+* Fix148 ks (#156)
+* flake fix
+* cleanup
+* gitignore
+* added ulautDestroyer to sampleSheetClass parser
+* fix #153 (#154)
 * bumped pandas version in env.yml
 * attempted to fix the pandas error
+* Main (#152)
 * old GH action was deprecated
 * Fix #148 (#149)
 * accent fixes in umlautDestroyer

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,2 @@
+sphinx==7.2.6
+sphinx_rtd_theme==2.0.0
diff --git a/env.yml b/env.yml
@@ -17,7 +17,6 @@ dependencies:
   - pbr >=5.10
   - rich-click >=1.5
   - biopython >=1.7
-  - sphinx >=5.1.1
   - bbmap >= 38.98
   - multiqc >= 1.12
   - fastqc >= 0.11.9
@@ -28,5 +27,4 @@ dependencies:
   - pip:  
     - interop >=1.1
     - pytest-datafiles >=2.0
-    - sphinx_rtd_theme >=1.0.0
     - pre-commit