From: "Joshua Watt" <JPEWhacker@gmail.com>
To: docs@lists.yoctoproject.org
Cc: Joshua Watt <JPEWhacker@gmail.com>
Subject: [docs][PATCH] documentation: Add Pipenv support
Date: Tue, 10 Nov 2020 15:29:17 -0600 [thread overview]
Message-ID: <20201110212917.25172-1-JPEWhacker@gmail.com> (raw)
Adds a Pipfile so that Pipenv can be used to automatically install all
the dependencies required to build the documentation
Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
---
documentation/.gitignore | 1 +
documentation/Pipfile | 14 ++++++++++++++
documentation/README | 7 +++++++
3 files changed, 22 insertions(+)
create mode 100644 documentation/Pipfile
diff --git a/documentation/.gitignore b/documentation/.gitignore
index 69fa449dd..21bb72530 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 000000000..7ee1d2290
--- /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 534ae66f8..28d5c4be8 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
==================================
--
2.29.2
next reply other threads:[~2020-11-10 21:29 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-11-10 21:29 Joshua Watt [this message]
2020-11-11 21:30 ` [PATCH] documentation: Add Pipenv support shantanoo.desai
2020-11-11 22:05 ` [docs] " Joshua Watt
2020-11-12 7:29 ` Nicolas Dechesne
2020-11-12 9:41 ` Quentin Schulz
2020-11-12 9:58 ` Nicolas Dechesne
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20201110212917.25172-1-JPEWhacker@gmail.com \
--to=jpewhacker@gmail.com \
--cc=docs@lists.yoctoproject.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.