diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index be8cd785fa952d6c6d95bb8815bfe9b6f70b98c9..3c6b7bca1a932f6a66b5fe9b581d9431e786cd7f 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -76,7 +76,9 @@ pages: image: python:3.9 stage: doc before_script: - - pip3 install sphinx==7.2.6 networkx==2.5 sphinxcontrib-apidoc==0.5.0 sphinx-rtd-theme==2.0.0 Jinja2==3.0.3 recommonmark==0.6.0 nbsphinx==0.9.3 nbconvert==6.4.3 sphinxcontrib-napoleon==0.7 sphinx-autoapi==3.0.0 graphviz ipython==7.20.0 json_schema_for_humans==0.40.3 pandoc --break-system-packages + - apt-get update + - apt-get install -y pandoc + - pip3 install sphinx==7.2.6 networkx==2.5 sphinxcontrib-apidoc==0.5.0 sphinx-rtd-theme==2.0.0 Jinja2==3.0.3 recommonmark==0.6.0 nbsphinx==0.9.3 nbconvert==6.4.3 sphinxcontrib-napoleon==0.7 sphinx-autoapi==3.0.0 graphviz ipython==7.20.0 json_schema_for_humans==0.40.3 --break-system-packages script: - mkdir public - make -C doc/ html diff --git a/doc/index.rst b/doc/index.rst index 04a0904c103099cfd469f4f29f76a2853dbd52d8..474dd5f576928f7dc918d56f1259a6fe73008ad5 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -12,21 +12,29 @@ Installation It is recommended to create a virtual environment before installing the package. -`python -m venv /path/to/venv/` +.. code-block:: bash + + python -m venv /path/to/venv/ Activate the venv -`source /path/to/venv/bin/activate` +.. code-block:: bash + + source /path/to/venv/bin/activate` The project is managed by the `pyproject.toml`-file. Hence, an installation with `pip` is the prefered way. In the next step we clone the pafsim repository: -`git clone https://gitlab.mpcdf.mpg.de/nesser/pafsim && cd pafsim` +.. code-block:: bash + + git clone https://gitlab.mpcdf.mpg.de/nesser/pafsim && cd pafsim and install it -`pip install .` +.. code-block:: bash + + pip install . All required dependencies are resolved.