search

zaneveld / karenina

Simulation and modeling tools for studying Anna Karenina effects in animal microbiomes
2 stars 6 forks source link

Addition of Documentation, Error fixes #49

Closed SLPeoples closed 6 years ago

SLPeoples commented 6 years ago

Development of documentation and general cleaning/ updating output and input files.

Moved q2-karenina to https://github.com/zaneveld/q2-karenina, prepared karenina for implementation in Qiime2.

Developed tutorials and installation instructions for use in documentation.

To activate https://zaneveld.github.io/karenina/html/

  1. Navigate to https://github.com/zaneveld/karenina/settings

  2. Scroll to GitHub Pages

  3. Select /docs

  4. Save

To update sphinx documentation after updating block-comments or changing karenina/docs/index.txt

  1. Navigate to karenina/docs/ in a command prompt window

  2. Execute the following command

sphinx-build -b html ./ ./html

  1. Open karenina/docs/html/genindex.html, index.html, py-modindex.html, and search.html,

  2. Delete all instances of _static/

  3. Delete the contents of karenina/docs/html/_static

These steps are necessary to ensure that GitHub Pages and Sphinx documentation are in-line with each other.

zaneveld commented 6 years ago

Nice work! I added some minor coding style items it would be great to fix before merging.

Would it also be possible to rename the /example_nonsense/ folder to something with a clearer meaning? For example, if this is a minimal usage example maybe minimal_example, etc.