mirror of
https://git.yoctoproject.org/git/poky
synced 2026-01-04 16:10:04 +00:00
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: 31658ad30827d38dcd4ea83bcfb828441c7c3eca) Signed-off-by: Joshua Watt <JPEWhacker@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
parent
a8ec1f72ba
commit
89a4534f81
1
documentation/.gitignore
vendored
1
documentation/.gitignore
vendored
|
|
@ -1 +1,2 @@
|
|||
_build/
|
||||
Pipfile.lock
|
||||
|
|
|
|||
14
documentation/Pipfile
Normal file
14
documentation/Pipfile
Normal 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"
|
||||
|
|
@ -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
|
||||
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
|
||||
==================================
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user