Skip to content

Commit 5521f24

Browse files
authored
Merge pull request #79 from ke-zhang-rd/doctr-doc-warning
DOC: update doctr instruction
2 parents a3e3da7 + 26a7812 commit 5521f24

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

docs/source/publishing-docs.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,12 @@ We recommend `doctr <https://drdoctr.github.io/doctr/>`_ a tool that configures
1515
Travis-CI to automatically publish your documentation every time the master
1616
branch is updated.
1717

18+
.. warning::
19+
The repo you want to build the docs for has to be a root repo.
20+
You cannot build docs for a forked repo by doctr yet.
21+
The doctr team is working on enabling a forked repo build under
22+
`PR #343 <https://github.com/drdoctr/doctr/pull/343>`_.
23+
1824
Install doctr.
1925

2026
.. code-block:: bash

0 commit comments

Comments
 (0)