Rfam Documentation
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
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
- Fork the repo or create a new branch
- Make changes using GitHub interface
- Send a pull request
Edit locally
- Fork the repo or create a new branch
- Install documentation
- Build and view HTML output locally
- Make changes
- Commit and push to GitHub
- 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.