Skip to content

DOC: update doctr instruction #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mrakitin merged 5 commits into from
Jan 13, 2020
Merged

DOC: update doctr instruction #79

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
02d36be
DOC: update doctr instruction
Jan 10, 2020
ccd6203
Update docs/source/publishing-docs.rst
Jan 10, 2020
fdabee7
DOC: Use warning block
Jan 10, 2020
0f4f4f7
Update docs/source/publishing-docs.rst
Jan 10, 2020
26a7812
Update docs/source/publishing-docs.rst
Jan 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/source/publishing-docs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,12 @@ We recommend `doctr <https://drdoctr.github.io/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 yet.
The doctr team is working on enabling a forked repo build under
`PR #343 <https://github.com/drdoctr/doctr/pull/343>`_.

Install doctr.

.. code-block:: bash
Expand Down