RiboKit : Doc Standards

Internal Guideline on Writing Standards

Documentation Standards

This page is intended to standarize documentation and tutorial writing format for RiboKit website.

Landing pages for each package should be placed under repos/ with their name, e.g. ribovis.md.

Text Format

Image Format

Docs Integration

For tutorials that are mostly hand-written, we prefer Markdown format.

For Python docstrings that live inside the code .py files, we prefer Sphinx compilation to HTML.


RiboKit Icon RiboKit Vertical Logo RiboKit Horizontal Logo

Built with Jekyll using a RiboKit Theme . Hosted on GitHub Pages.