Rfam documentation and help hosted on ReadTheDocs
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
LICENSE
Readme.rst
requirements.txt

Readme.rst

Rfam Documentation

Documentation Status

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

Installation

# create a new virtual environment
virtualenv /path/to/new/rfam-docs-virtualenv

# activate virtual environment
source /path/to/new/rfam-docs-virtualenv/bin/activate

# install Python dependencies
cd /path/to/rfam-docs
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 rfam-help@ebi.ac.uk.