Skip to content

Commit

Permalink
Fix read the docs build (#820)
Browse files Browse the repository at this point in the history
* add environment config for conda in readthedocs

* use python confs

* add checking readthedocs to instructions
  • Loading branch information
luizirber committed Jan 4, 2020
1 parent 3f800f3 commit 6bcf1ee
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 2 deletions.
21 changes: 21 additions & 0 deletions .readthedocs.yml
@@ -0,0 +1,21 @@
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

version: 2

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: doc/conf.py

conda:
environment: doc/environment.yml

python:
version: 3.7
install:
- method: pip
path: .
extra_requirements:
- doc
system_packages: true
5 changes: 5 additions & 0 deletions doc/environment.yml
@@ -0,0 +1,5 @@
channels:
- conda-forge
- defaults
dependencies:
- rust
6 changes: 4 additions & 2 deletions doc/release.md
@@ -1,6 +1,5 @@
# Releasing a new version of sourmash


These are adapted from the khmer release docs, originally written by
Michael Crusoe.

Expand All @@ -10,6 +9,9 @@ Remember to update release numbers/RC in:

## Testing a release

0\. First things first: check if Read the Docs is building properly for
master. Build on https://readthedocs.org/projects/sourmash/builds/ should be
passing, and also check if https://sourmash.readthedocs.io/en/latest/ is updated.

1\. The below should be done in a clean checkout:
```
Expand All @@ -19,7 +21,7 @@ cd sourmash
```
2\. Set your new version number and release candidate (you might want to check https://github.com/dib-lab/sourmash/releases for next version number):
```
new_version=1.0.0
new_version=3.0.0
rc=rc1
```
and then tag the release candidate with the new version number prefixed by
Expand Down

0 comments on commit 6bcf1ee

Please sign in to comment.