From bc3e57d551faa5f444107d0a41fcf56f4870ca8c Mon Sep 17 00:00:00 2001 From: Lysandre Date: Tue, 22 Oct 2019 17:51:30 -0400 Subject: [PATCH 1/5] Multi version doc deployment --- .circleci/config.yml | 6 +++--- .circleci/deploy.sh | 21 +++++++++++++++++++++ 2 files changed, 24 insertions(+), 3 deletions(-) create mode 100755 .circleci/deploy.sh diff --git a/.circleci/config.yml b/.circleci/config.yml index 637d137492..38d0e291af 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -81,12 +81,12 @@ jobs: - checkout - run: sudo pip install --progress-bar off -r docs/requirements.txt - run: sudo pip install --progress-bar off -r requirements.txt - - run: cd docs && make clean && make html && scp -r -oStrictHostKeyChecking=no _build/html/* $doc:$dir + - run: ./deploy.sh workflow_filters: &workflow_filters filters: branches: only: - - master + - deploy_doc workflows: version: 2 build_and_test: @@ -96,4 +96,4 @@ workflows: - build_py3_tf - build_py2_torch - build_py2_tf - - deploy_doc: *workflow_filters \ No newline at end of file + - deploy_doc: *workflow_filters diff --git a/.circleci/deploy.sh b/.circleci/deploy.sh new file mode 100755 index 0000000000..19226ae4d5 --- /dev/null +++ b/.circleci/deploy.sh @@ -0,0 +1,21 @@ +cd docs + +function deploy_doc(){ + echo "Creating doc at commit $1 and pushing to folder $2" + git checkout $1 + if [ ! -z "$2" ] + then + echo "Pushing version" $2 + make clean && make html && scp -r -oStrictHostKeyChecking=no _build/html $doc:$dir/$2 + else + echo "Pushing master" + make clean && make html && scp -r -oStrictHostKeyChecking=no _build/html/* $doc:$dir + fi +} + +deploy_doc "master" +deploy_doc "b33a385" v1.0.0 +deploy_doc "fe02e45" v1.1.0 +eploy_doc "89fd345" v1.2.0 +deploy_doc "fc9faa8" v2.0.0 +deploy_doc "3ddce1d" v2.1.1 From 69eba0ab19fda74ff00f1e4f5bded98a2fec9887 Mon Sep 17 00:00:00 2001 From: Lysandre Date: Tue, 22 Oct 2019 17:53:52 -0400 Subject: [PATCH 2/5] Edit script path --- .circleci/config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 38d0e291af..4c6423ada4 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -81,7 +81,7 @@ jobs: - checkout - run: sudo pip install --progress-bar off -r docs/requirements.txt - run: sudo pip install --progress-bar off -r requirements.txt - - run: ./deploy.sh + - run: ./.circleci/deploy.sh workflow_filters: &workflow_filters filters: branches: From fbcc5ff9fbad6e42d5d852fe315eb4c01707ed2e Mon Sep 17 00:00:00 2001 From: Lysandre Date: Tue, 22 Oct 2019 18:01:10 -0400 Subject: [PATCH 3/5] Change branch to master --- .circleci/config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 4c6423ada4..01e6d82b33 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -86,7 +86,7 @@ workflow_filters: &workflow_filters filters: branches: only: - - deploy_doc + - master workflows: version: 2 build_and_test: From 6e85bccafc8a175c0cc2eed27fd61af087483085 Mon Sep 17 00:00:00 2001 From: Lysandre Debut Date: Tue, 22 Oct 2019 18:07:01 -0400 Subject: [PATCH 4/5] Fixed typo --- .circleci/deploy.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.circleci/deploy.sh b/.circleci/deploy.sh index 19226ae4d5..2bff0102ae 100755 --- a/.circleci/deploy.sh +++ b/.circleci/deploy.sh @@ -16,6 +16,6 @@ function deploy_doc(){ deploy_doc "master" deploy_doc "b33a385" v1.0.0 deploy_doc "fe02e45" v1.1.0 -eploy_doc "89fd345" v1.2.0 +deploy_doc "89fd345" v1.2.0 deploy_doc "fc9faa8" v2.0.0 deploy_doc "3ddce1d" v2.1.1 From b82bfbd0c307ba84da4f326900f1479df977efeb Mon Sep 17 00:00:00 2001 From: Lysandre Date: Thu, 24 Oct 2019 15:55:31 +0000 Subject: [PATCH 5/5] Updated README to show all available documentation --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e8506d6a39..3d89c65901 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ Choose the right framework for every part of a model's lifetime | [Quick tour: Fine-tuning/usage scripts](#quick-tour-of-the-fine-tuningusage-scripts) | Using provided scripts: GLUE, SQuAD and Text generation | | [Migrating from pytorch-transformers to transformers](#Migrating-from-pytorch-transformers-to-transformers) | Migrating your code from pytorch-transformers to transformers | | [Migrating from pytorch-pretrained-bert to pytorch-transformers](#Migrating-from-pytorch-pretrained-bert-to-transformers) | Migrating your code from pytorch-pretrained-bert to transformers | -| [Documentation](https://huggingface.co/transformers/) | Full API documentation and more | +| [Documentation](https://huggingface.co/transformers/) [(v2.1.1)](https://huggingface.co/transformers/v2.1.1) [(v2.0.0)](https://huggingface.co/transformers/v2.0.0) [(v1.2.0)](https://huggingface.co/transformers/v1.2.0) [(v1.1.0)](https://huggingface.co/transformers/v1.1.0) [(v1.0.0)](https://huggingface.co/transformers/v1.0.0) | Full API documentation and more | ## Installation