From 6cbef3ec897705c5bbb17b76cd958a0c2593525e Mon Sep 17 00:00:00 2001 From: Aman Dalmia <amandalmia18@gmail.com> Date: Tue, 29 Nov 2016 18:22:44 +0530 Subject: [PATCH] [MRG+1] DOC adding info about circleci build artifacts (#7855) --- doc/developers/contributing.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/doc/developers/contributing.rst b/doc/developers/contributing.rst index c06773fae5..7c6c7e12a7 100644 --- a/doc/developers/contributing.rst +++ b/doc/developers/contributing.rst @@ -383,6 +383,17 @@ documentation with the maths makes it more friendly towards users that are just interested in what the feature will do, as opposed to how it works "under the hood". +You may also be asked to show your changes when it's built. When you create +a pull request or make changes in an existing one modifying the docs, CircleCI +automatically builds them. Thus, you can easily view your changes in the built +artifacts using the following formula: + +``http://scikit-learn.org/circle?{BUILD_NUMBER}`` + +Note: When you visit the details page of the CircleCI tests, you can find your +BUILD_NUMBER mentioned as 'build #' which is different from your pull request +number, which is presented as 'pull/#'. + Finally, follow the formatting rules below to make it consistently good: * Add "See also" in docstrings for related classes/functions. -- GitLab