Skip to content

Commit

Permalink
Docs build fix in local setup
Browse files Browse the repository at this point in the history
* Using Docker instead of virtual environment
  • Loading branch information
razrotenberg committed Feb 7, 2024
1 parent 870c36c commit 32724e0
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 9 deletions.
4 changes: 4 additions & 0 deletions devel/docs.Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
FROM sphinxdoc/sphinx:2.4.4

COPY requirements.txt /
RUN pip install -r /requirements.txt
11 changes: 2 additions & 9 deletions docs/source/development/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -220,20 +220,13 @@ Setup
~~~~~
.. code-block:: shell
python -m venv .venv
source .venv/bin/activate
python -m pip install sphinx
python -m pip install -r docs/requirements.txt
.. note::

You might need to use :code:`python3` instead of :code:`python`
docker build -t genv:docs -f devel/docs.Dockerfile docs
Build
~~~~~
.. code-block:: shell
make -C docs/ html
docker run -it --rm -v $PWD/docs:/docs genv:docs
Python Package
--------------
Expand Down

0 comments on commit 32724e0

Please sign in to comment.