From 02d36bef526d54e11403d61bcde7d488d7c9d710 Mon Sep 17 00:00:00 2001 From: ke-zhang-rd Date: Fri, 10 Jan 2020 12:24:52 -0500 Subject: [PATCH 1/5] DOC: update doctr instruction --- docs/source/publishing-docs.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/source/publishing-docs.rst b/docs/source/publishing-docs.rst index 0c682db..9d914f5 100644 --- a/docs/source/publishing-docs.rst +++ b/docs/source/publishing-docs.rst @@ -15,6 +15,9 @@ We recommend `doctr `_ a tool that configures Travis-CI to automatically publish your documentation every time the master branch is updated. +**WANRING: The repo you want to build the docs for has to be a root repo. You +cannot build docs for a forked repo by doctr.** + Install doctr. .. code-block:: bash From ccd6203402414e0bc9493f6ca97e0d693d54100f Mon Sep 17 00:00:00 2001 From: Ke Zhang Date: Fri, 10 Jan 2020 13:27:31 -0500 Subject: [PATCH 2/5] Update docs/source/publishing-docs.rst Co-Authored-By: Maksim Rakitin --- docs/source/publishing-docs.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/publishing-docs.rst b/docs/source/publishing-docs.rst index 9d914f5..afb2a97 100644 --- a/docs/source/publishing-docs.rst +++ b/docs/source/publishing-docs.rst @@ -15,7 +15,7 @@ We recommend `doctr `_ a tool that configures Travis-CI to automatically publish your documentation every time the master branch is updated. -**WANRING: The repo you want to build the docs for has to be a root repo. You +**WARNING: The repo you want to build the docs for has to be a root repo. You cannot build docs for a forked repo by doctr.** Install doctr. From fdabee72497195b02908376708382c8785f2db37 Mon Sep 17 00:00:00 2001 From: ke-zhang-rd Date: Fri, 10 Jan 2020 13:35:45 -0500 Subject: [PATCH 3/5] DOC: Use warning block --- docs/source/publishing-docs.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/source/publishing-docs.rst b/docs/source/publishing-docs.rst index afb2a97..737b951 100644 --- a/docs/source/publishing-docs.rst +++ b/docs/source/publishing-docs.rst @@ -15,8 +15,10 @@ We recommend `doctr `_ a tool that configures Travis-CI to automatically publish your documentation every time the master branch is updated. -**WARNING: The repo you want to build the docs for has to be a root repo. You -cannot build docs for a forked repo by doctr.** +.. warning:: + The repo you want to build the docs for has to be a root repo. + You cannot build docs for a forked repo by doctr. + doctr is working on enable forked repo build under `PR343 `_ Install doctr. From 0f4f4f785ebf68fd43061794274ab05fd1c8a2ae Mon Sep 17 00:00:00 2001 From: Ke Zhang Date: Fri, 10 Jan 2020 14:01:43 -0500 Subject: [PATCH 4/5] Update docs/source/publishing-docs.rst Co-Authored-By: Maksim Rakitin --- docs/source/publishing-docs.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/source/publishing-docs.rst b/docs/source/publishing-docs.rst index 737b951..19532d4 100644 --- a/docs/source/publishing-docs.rst +++ b/docs/source/publishing-docs.rst @@ -18,7 +18,8 @@ branch is updated. .. warning:: The repo you want to build the docs for has to be a root repo. You cannot build docs for a forked repo by doctr. - doctr is working on enable forked repo build under `PR343 `_ + The doctr team is working on enabling a forked repo build under + `PR #343 `_. Install doctr. From 26a7812523fb94f8fcf14aae0fda39cf066bc43e Mon Sep 17 00:00:00 2001 From: Ke Zhang Date: Fri, 10 Jan 2020 14:01:52 -0500 Subject: [PATCH 5/5] Update docs/source/publishing-docs.rst Co-Authored-By: Maksim Rakitin --- docs/source/publishing-docs.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/publishing-docs.rst b/docs/source/publishing-docs.rst index 19532d4..e9d8afe 100644 --- a/docs/source/publishing-docs.rst +++ b/docs/source/publishing-docs.rst @@ -17,7 +17,7 @@ branch is updated. .. warning:: The repo you want to build the docs for has to be a root repo. - You cannot build docs for a forked repo by doctr. + You cannot build docs for a forked repo by doctr yet. The doctr team is working on enabling a forked repo build under `PR #343 `_.