Skip to content

Rfam/rfam-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Rfam Documentation

Documentation Status

This repository is the source of Rfam documentation hosted on Read The Docs.

Installation

cd /path/to/rfam-docs

# create a new virtual environment
virtualenv `pwd`/env

# activate virtual environment
source env/bin/activate

# install Python dependencies
python -m pip install -r requirements.txt

# serve documentation locally at http://127.0.0.1:8000
cd docs
sphinx-autobuild source build

How to contribute

Edit on GitHub

  1. Fork the repo or create a new branch
  2. Make changes using GitHub interface
  3. Send a pull request

Edit locally

  1. Fork the repo or create a new branch
  2. Install documentation
  3. Build and view HTML output locally
  4. Make changes
  5. Commit and push to GitHub
  6. Send a pull request

Contact

If you have any questions or feedback, feel free to submit a new issue or email us at [email protected].