mirror of
https://github.com/nextcloud/documentation.git
synced 2026-01-02 17:59:36 +07:00
feat(setup): Advertise venv
Signed-off-by: Joas Schilling <coding@schilljs.com> Signed-off-by: Richard Steinmetz <richard@steinmetz.cloud>
This commit is contained in:
committed by
Richard Steinmetz
parent
a1fb4315fd
commit
2c35b1487e
18
README.rst
18
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
|
||||
|
||||
Reference in New Issue
Block a user