diff options
| author | Joshua Watt <JPEWhacker@gmail.com> | 2020-11-10 15:29:17 -0600 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2021-01-04 10:55:02 +0000 |
| commit | 87a281831d36c2ee9a759103ce7838875dbca021 (patch) | |
| tree | d3dbb49f69a9d40f9370d10c5bafe085dc4a8c3a /documentation/README | |
| parent | ee78efdbfc2e63d765a874f8e3bacf0295ba32c7 (diff) | |
| download | poky-87a281831d36c2ee9a759103ce7838875dbca021.tar.gz | |
documentation: Add Pipenv support
Adds a Pipfile so that Pipenv can be used to automatically install all
the dependencies required to build the documentation
(From yocto-docs rev: 5fc0a3011c47388d9c6447c3be00fefcbaf00f5c)
Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 31658ad30827d38dcd4ea83bcfb828441c7c3eca)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/README')
| -rw-r--r-- | documentation/README | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/documentation/README b/documentation/README index 534ae66f86..28d5c4be8e 100644 --- a/documentation/README +++ b/documentation/README | |||
| @@ -127,6 +127,13 @@ The resulting HTML index page will be _build/html/index.html, and you | |||
| 127 | can browse your own copy of the locally generated documentation with | 127 | can browse your own copy of the locally generated documentation with |
| 128 | your browser. | 128 | your browser. |
| 129 | 129 | ||
| 130 | Alternatively, you can use Pipenv to automatically install all required | ||
| 131 | dependencies in a virtual environment: | ||
| 132 | |||
| 133 | $ cd documentation | ||
| 134 | $ pipenv install | ||
| 135 | $ pipenv run make html | ||
| 136 | |||
| 130 | Sphinx theme and CSS customization | 137 | Sphinx theme and CSS customization |
| 131 | ================================== | 138 | ================================== |
| 132 | 139 | ||
