diff options
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/.gitignore | 1 | ||||
| -rw-r--r-- | documentation/Pipfile | 14 | ||||
| -rw-r--r-- | documentation/README | 7 |
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/ |
| 2 | 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 @@ | |||
| 1 | [[source]] | ||
| 2 | name = "pypi" | ||
| 3 | url = "https://pypi.org/simple" | ||
| 4 | verify_ssl = true | ||
| 5 | |||
| 6 | [dev-packages] | ||
| 7 | |||
| 8 | [packages] | ||
| 9 | sphinx = "*" | ||
| 10 | sphinx-rtd-theme = "*" | ||
| 11 | pyyaml = "*" | ||
| 12 | |||
| 13 | [requires] | ||
| 14 | 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 | |||
| 127 | can browse your own copy of the locally generated documentation with | 127 | can browse your own copy of the locally generated documentation with |
| 128 | your browser. | 128 | your browser. |
| 129 | 129 | ||
| 130 | Alternatively, you can use Pipenv to automatically install all required | ||
| 131 | dependencies in a virtual environment: | ||
| 132 | |||
| 133 | $ cd documentation | ||
| 134 | $ pipenv install | ||
| 135 | $ pipenv run make html | ||
| 136 | |||
| 130 | Sphinx theme and CSS customization | 137 | Sphinx theme and CSS customization |
| 131 | ================================== | 138 | ================================== |
| 132 | 139 | ||