summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--documentation/.gitignore1
-rw-r--r--documentation/Pipfile14
-rw-r--r--documentation/README7
3 files changed, 22 insertions, 0 deletions
diff --git a/documentation/.gitignore b/documentation/.gitignore
index 69fa449dd9..21bb72530a 100644
--- a/documentation/.gitignore
+++ b/documentation/.gitignore
@@ -1 +1,2 @@
1_build/ 1_build/
2Pipfile.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 @@
1[[source]]
2name = "pypi"
3url = "https://pypi.org/simple"
4verify_ssl = true
5
6[dev-packages]
7
8[packages]
9sphinx = "*"
10sphinx-rtd-theme = "*"
11pyyaml = "*"
12
13[requires]
14python_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
127can browse your own copy of the locally generated documentation with 127can browse your own copy of the locally generated documentation with
128your browser. 128your browser.
129 129
130Alternatively, you can use Pipenv to automatically install all required
131dependencies in a virtual environment:
132
133 $ cd documentation
134 $ pipenv install
135 $ pipenv run make html
136
130Sphinx theme and CSS customization 137Sphinx theme and CSS customization
131================================== 138==================================
132 139