Add Pipenv support to docs

jt-nti · jt-nti · commit b90c0c0703ce · 2019-08-06T14:43:23.000+01:00
Simplifies local doc builds

Signed-off-by: James Taylor &lt;jamest@uk.ibm.com&gt;
Change-Id: I5c68c90372b26b297b26b963aedca6e9b8d56b96
Signed-off-by: James Taylor &lt;jamest@uk.ibm.com&gt;
diff --git a/docs/Pipfile b/docs/Pipfile
@@ -0,0 +1,14 @@
+[[source]]
+name = "pypi"
+url = "https://pypi.org/simple"
+verify_ssl = true
+
+[dev-packages]
+
+[packages]
+sphinx = "*"
+sphinx-rtd-theme = "*"
+recommonmark = "==0.4.0"
+
+[requires]
+python_version = "3.7"
diff --git a/docs/Pipfile.lock b/docs/Pipfile.lock
diff --git a/docs/README.md b/docs/README.md
@@ -67,11 +67,14 @@ Here are the quick steps to achieve this on a local machine without
 depending on ReadTheDocs, starting from the main fabric
 directory. Note: you may need to adjust depending on your OS.
 
+Prereqs:
+ - [Python 3.7](https://wiki.python.org/moin/BeginnersGuide/Download)
+ - [Pipenv](https://docs.pipenv.org/en/latest/#install-pipenv-today)
+
 ```
-sudo pip install Sphinx
-sudo pip install sphinx_rtd_theme
-sudo pip install recommonmark==0.4.0
-cd fabric/docs # Be in this directory. Makefile sits there.
+cd fabric/docs
+pipenv install
+pipenv shell
 make html
 ```
 
diff --git a/scripts/functions.sh b/scripts/functions.sh
@@ -27,6 +27,8 @@ function filterExcludedAndGeneratedFiles {
         '(^|/)testdata\/'
         '(^|/)vendor\/'
         '\.json$'
+        '(^|/)Pipfile$'
+        '(^|/)Pipfile\.lock$'
     )
 
     local filter

Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,8 @@ function filterExcludedAndGeneratedFiles {`
`27`	`27`	`'(^\|/)testdata\/'`
`28`	`28`	`'(^\|/)vendor\/'`
`29`	`29`	`'\.json$'`
	`30`	`+ '(^\|/)Pipfile$'`
	`31`	`+ '(^\|/)Pipfile\.lock$'`
`30`	`32`	`)`
`31`	`33`
`32`	`34`	`local filter`