Merge pull request #244 from kngwyu/travis-doc

Build rust doc on travis
This commit is contained in:
konstin 2018-10-05 13:55:47 +02:00 committed by GitHub
commit 90dca39f08
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 13 additions and 3 deletions

View file

@ -10,6 +10,8 @@
* User Guide: [stable](https://pyo3.rs) | [master](https://pyo3.rs/master)
* API Documentation: [master](https://pyo3.rs/master/doc)
A comparison with rust-cpython can be found [in the guide](https://pyo3.rs/master/rust-cpython.html).
## Usage

View file

@ -16,8 +16,13 @@ fi
# Build and then upload the guide to a specific folder on the gh-pages branch. This way we can have multiple versions
# of the guide at the same time (See #165)
# This builds the book in target/doc/guide. See https://github.com/rust-lang-nursery/mdBook/issues/698
mdbook build -d ../target/doc/guide guide
# This builds the book in target/guide. See https://github.com/rust-lang-nursery/mdBook/issues/698
mdbook build -d ../target/guide guide
# Build the doc
# This builds the book in target/doc
cargo doc --all-features --no-deps
echo "<meta http-equiv=refresh content=0;url=pyo3/index.html>" > target/doc/index.html
# Get the lastest tag across all branches
# https://stackoverflow.com/a/7261049/3549270
@ -32,7 +37,8 @@ echo "pyo3.rs" > CNAME
# For builds triggered by a tag, $TRAVIS_BRANCH will be set to the tag
rm -rf "$TRAVIS_BRANCH"
cp -r ../target/doc/guide "$TRAVIS_BRANCH"
cp -r ../target/guide "$TRAVIS_BRANCH"
cp -r ../target/doc "$TRAVIS_BRANCH"
git add --all
git commit -m "Upload documentation for $TRAVIS_BRANCH"

View file

@ -2,6 +2,8 @@
[Rust](http://www.rust-lang.org/) bindings for [Python](https://www.python.org/). This includes running and interacting with python code from a rust binaries as well as writing native python modules.
[API documentation](./doc/index.html)
## Usage
Pyo3 supports python 2.7 as well as python 3.5 and up. The minimum required rust version is 1.29.0-nightly 2018-07-16.