https://github.com/biopython/docs
Repository for automatically deploying the Biopython documentation
https://github.com/biopython/docs
Last synced: 27 days ago
JSON representation
Repository for automatically deploying the Biopython documentation
- Host: GitHub
- URL: https://github.com/biopython/docs
- Owner: biopython
- Created: 2019-06-14T14:37:02.000Z (almost 7 years ago)
- Default Branch: gh-pages
- Last Pushed: 2026-02-19T09:38:51.000Z (about 1 month ago)
- Last Synced: 2026-02-19T14:27:47.137Z (about 1 month ago)
- Language: HTML
- Homepage:
- Size: 63.1 MB
- Stars: 8
- Watchers: 11
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
Awesome Lists containing this project
README
Automatically generated Biopython documentation
===============================================
This is new as of Biopython 1.74, released 16 July 2019.
The idea is that code changes on https://github.com/biopython/biopython
already undergo continuous integration testing, and one of those jobs will
render the latest documentation, and for the master branch, push it to this
separate https://github.com/biopython/docs/ repository on the ``gh-pages``
branch, from where it can be automatically published using GitHub pages.
The intention is to use https://biopython.org/docs/dev/api/ for the API
documentation for latest master branch, with ``/dev/`` replaced with the
version for releases, e.g. https://biopython.org/docs/1.74/api/ and a
symlink such that https://biopython.org/docs/latest/api/ points at the
latest release (which will need updating with each release).
We would not expect or intend to edit the documentation directly in this
repository.
If you find a mistake in the documentation, please check the dev version,
and if it is still broken, please file an issue on the main repository:
https://github.com/biopython/biopython/issues