From d7decb855d706bcfde8035bbce54ed10408a5fa5 Mon Sep 17 00:00:00 2001 From: Brad Rogers Date: Fri, 25 Sep 2020 15:35:10 -0700 Subject: [PATCH] Add local build for docs to contributing --- CONTRIBUTING.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e1ad63af..a1c55dc3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -60,6 +60,14 @@ Note: If you do not have all of these tokens available, we run integration tests We do recommend developing in a virtual environment in order to ensure you have a clean testing environment. +If you want to build the documentation locally, you can run this: + +``` +$ tox -e docs +``` + +The documentation will be built into `build/html`. + [issues]: https://github.com/dropbox/dropbox-sdk-python/issues [pr]: https://github.com/dropbox/dropbox-sdk-python/pulls [coc]: https://github.com/dropbox/dropbox-sdk-python/blob/master/CODE_OF_CONDUCT.md