mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-01-29 21:08:42 +01:00
Code Issues Packages Projects Releases Wiki Activity

documentation: Add Pipenv support

Browse Source 
Adds a Pipfile so that Pipenv can be used to automatically install all
the dependencies required to build the documentation

(From yocto-docs rev: 31658ad30827d38dcd4ea83bcfb828441c7c3eca)

Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Joshua Watt
2020-11-10 15:29:17 -06:00
committed by Richard Purdie
parent a8ec1f72ba
commit 89a4534f81
3 changed files with 22 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
documentation/.gitignore vendored
View File

@@ -1 +1,2 @@
_build/ _build/
Pipfile.lock

14
documentation/Pipfile Normal file
View File

@@ -0,0 +1,14 @@
[[source]]
name = "pypi"
url = "https://pypi.org/simple"
verify_ssl = true
[dev-packages]
[packages]
sphinx = "*"
sphinx-rtd-theme = "*"
pyyaml = "*"
[requires]
python_version = "3"

7
documentation/README
View File

@@ -127,6 +127,13 @@ The resulting HTML index page will be _build/html/index.html, and you
can browse your own copy of the locally generated documentation with can browse your own copy of the locally generated documentation with
your browser. your browser.
Alternatively, you can use Pipenv to automatically install all required
dependencies in a virtual environment:
$ cd documentation
$ pipenv install
$ pipenv run make html
Sphinx theme and CSS customization Sphinx theme and CSS customization
================================== ==================================