From 6cf219611c3c38f762dae268be0b3dc2bf622fa2 Mon Sep 17 00:00:00 2001 From: Jeremy Cline Date: Feb 02 2017 21:14:22 +0000 Subject: Expand the README to include virtualenv instructions Signed-off-by: Jeremy Cline --- diff --git a/README.rst b/README.rst index b204baf..edbe485 100644 --- a/README.rst +++ b/README.rst @@ -10,10 +10,12 @@ those applications we maintain ourselves. This is designed to be consumed as a Sphinx documentation project. Documentation is available online on `pagure `_ and on -`Read the Docs `_ +`Read the Docs `_. To build the documentation locally, create a virtualenv and install the requirements:: + $ sudo dnf install python-virtualenvwrapper + $ mkvirtualenv -a $(pwd) infra-docs $ pip install -r requirements.txt then build the documentation and open it in a browser of your choice:: @@ -21,3 +23,15 @@ then build the documentation and open it in a browser of your choice:: $ cd docs $ make html $ firefox _build/html/index.html + +To leave the virtual environment:: + + $ deactivate + +Finally, when you want to work on the documentation, you can re-enter the +virtual environment with:: + + $ workon infra-docs + +It will automatically change the current working directory to the repository +root.