Mirror/pmbootstrap
1
0
Fork 1
mirror of https://gitlab.postmarketos.org/postmarketOS/pmbootstrap.git synced 2025-07-12 19:09:56 +03:00
Code Issues Wiki Activity

docs/index: introduce local deploy example

Browse source 
Part-of: https://gitlab.postmarketos.org/postmarketOS/pmbootstrap/-/merge_requests/2599
This commit is contained in:
Alexey Andreyev 2025-05-13 15:01:28 +03:00 • committed by Oliver Smith
parent abb8d92437
commit a61fd50d6f
No known key found for this signature in database
GPG key ID: 5AE7F5513E0885CB
1 changed files with 17 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

17
docs/index.rst
View file

@ -35,6 +35,23 @@ Indices and tables
* :ref:`modindex`
* :ref:`search`
Deploying locally
=================
To deploy with python virtual environment and sphinx-autobuild:
.. code-block:: sh
cd /path/to/pmbootstrap
python -m venv build-sphinx-env
source ./build-sphinx-env/bin/activate
pip install sphinx-autobuild sphinx_rtd_theme myst-parser sphinxcontrib-autoprogram
sphinx-autobuild docs docs/_build/html
.. code-block:: text
[sphinx-autobuild] Serving on http://127.0.0.1:8000
[sphinx-autobuild] Waiting to detect changes...
*Note:* This documentation is currently a work-in-progress, your feedback and contributions are very welcome!