From 2c35b1487e83a1e5ce0f1eafff43a674bb44c145 Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Fri, 28 Jul 2023 16:27:50 +0200 Subject: [PATCH] feat(setup): Advertise venv Signed-off-by: Joas Schilling Signed-off-by: Richard Steinmetz --- README.rst | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 77ff83e64..4d2bd5abd 100644 --- a/README.rst +++ b/README.rst @@ -122,6 +122,9 @@ Nightly Automated Build Steps Building HTML ============= +Using pipenv +^^^^^^^^^^^^ + 1. Install ``pipenv`` - https://pipenv.readthedocs.io/en/latest/ 2. Create a Python environment (typically inside this repository): ``pipenv --python 3.9`` 3. Change into the environment: ``pipenv shell`` @@ -129,11 +132,22 @@ Building HTML 5. Now you can use ``make ...`` to build all the stuff - for example ``make html`` to build the HTML flavor of all manuals The build assets will be put into the individual documentation subdirectories like ``developer_manual/_build/html/com`` - To change into this environment you need to run ``pipenv shell`` to launch the shell and to exit you can use either ``exit`` or ``Ctrl`` + ``D``. -When editing the documentation installing ``sphinx-autobuild`` though pip can be helpful. This will watch file changes and automatically reload the html preview: +Using venv +^^^^^^^^^^ +1. Install ``python3-venv`` +2. Only once: Create a venv (typically inside this repository): ``python -m venv venv`` +3. Activate the environment (inside this repository): ``source venv/bin/activate`` +4. Install the dependencies ``pip install -r requirements.txt`` +5. Now you can use ``make ...`` to build all the stuff - for example ``make html`` to build the HTML flavor of all manuals + The build assets will be put into the individual documentation subdirectories like ``developer_manual/_build/html/com`` + +Autobuilding +^^^^^^^^^^^^ + +When editing the documentation installing ``sphinx-autobuild`` though pip can be helpful. This will watch file changes and automatically reload the html preview: 1. Install ``pip install sphinx-autobuild`` 2. When building the developer documentation make sure to execute ``make openapi-spec`` in the repository root