mortazavilab / PyWGCNA

PyWGCNA is a Python package designed to do Weighted Gene Correlation Network analysis (WGCNA)
https://academic.oup.com/bioinformatics/advance-article/doi/10.1093/bioinformatics/btad415/7218311
MIT License
192 stars 46 forks source link

Synchronize documentation and class parameters #70

Closed ofarrelle closed 7 months ago

ofarrelle commented 8 months ago

These commits solve #69

  1. I manually updated the docstrings in PyWGCNA/geneExp.py and PyWGCNA/wgcna.py
  2. from the docs/ directory, I ran make html to update the docs. Note my Sphinx version is 7.2.6 and I also had to pip install myst-parser for it to work.
  3. A brief local check of the HTML doc files shows the changes have been applied.

Let me know if these were the correct steps to update the docs

ofarrelle commented 8 months ago

Apologies, I didn't mean for commit dd38ba0 to make it into this PR. Will revert soon.