瀏覽代碼

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>
Joshua Watt 4 年之前
父節點
當前提交
89a4534f81
共有 3 個文件被更改,包括 22 次插入0 次删除
  1. 1 0
      documentation/.gitignore
  2. 14 0
      documentation/Pipfile
  3. 7 0
      documentation/README

+ 1 - 0
documentation/.gitignore

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

+ 14 - 0
documentation/Pipfile

@@ -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 - 0
documentation/README

@@ -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
 ==================================