From 87a281831d36c2ee9a759103ce7838875dbca021 Mon Sep 17 00:00:00 2001 From: Joshua Watt Date: Tue, 10 Nov 2020 15:29:17 -0600 Subject: 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 Signed-off-by: Richard Purdie (cherry picked from commit 31658ad30827d38dcd4ea83bcfb828441c7c3eca) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie --- documentation/.gitignore | 1 + documentation/Pipfile | 14 ++++++++++++++ documentation/README | 7 +++++++ 3 files changed, 22 insertions(+) create mode 100644 documentation/Pipfile (limited to 'documentation') diff --git a/documentation/.gitignore b/documentation/.gitignore index 69fa449dd9..21bb72530a 100644 --- a/documentation/.gitignore +++ b/documentation/.gitignore @@ -1 +1,2 @@ _build/ +Pipfile.lock diff --git a/documentation/Pipfile b/documentation/Pipfile new file mode 100644 index 0000000000..7ee1d22905 --- /dev/null +++ b/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" 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 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 ================================== -- cgit v1.2.3-54-g00ecf