Skip to content

Commit

Permalink
docs: Syntax-highlight all the code blocks!
Browse files Browse the repository at this point in the history
  • Loading branch information
Wuestengecko committed Feb 6, 2024
1 parent c92cf6a commit 1f45f10
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 24 deletions.
18 changes: 9 additions & 9 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ correctly:

__ README.rst#installation

.. code::
.. code:: bash
pytest
pytest
We additionally recommend that you set up your editor / IDE as follows.

Expand All @@ -46,11 +46,11 @@ We additionally recommend that you set up your editor / IDE as follows.

.. code:: json
"[python]": {
"editor.codeActionsOnSave": {
"source.organizeImports": true
}
}
"[python]": {
"editor.codeActionsOnSave": {
"source.organizeImports": true
}
}
Note that the Pylance language server is not recommended, as it occasionally
causes false-positive errors for perfectly valid code.
Expand All @@ -61,9 +61,9 @@ We additionally recommend that you set up your editor / IDE as follows.

__ https://github.com/python-lsp/python-lsp-server

.. code::
.. code:: bash
pip install "python-lsp-server[pylint]" python-lsp-black pyls-isort pylsp-mypy
pip install "python-lsp-server[pylint]" python-lsp-black pyls-isort pylsp-mypy
This will provide as-you-type linting as well as automatic formatting on
save. Language server clients are available for a wide range of editors, from
Expand Down
30 changes: 15 additions & 15 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -198,35 +198,35 @@ and use ``capellambse`` in a local, trusted environment.

You can install the latest released version directly from PyPI.

.. code::
.. code:: bash
pip install capellambse
pip install capellambse
To set up a development environment, clone the project and install it into a
virtual environment.

.. code::
.. code:: bash
git clone https://github.com/DSD-DBS/py-capellambse
cd capellambse
python -m venv .venv
git clone https://github.com/DSD-DBS/py-capellambse
cd capellambse
python -m venv .venv
source .venv/bin/activate.sh # for Linux / Mac
.venv\Scripts\activate # for Windows
source .venv/bin/activate.sh # for Linux / Mac
.venv\Scripts\activate # for Windows
pip install -U pip pre-commit
pip install -e '.[docs,test]'
pre-commit install
pip install -U pip pre-commit
pip install -e '.[docs,test]'
pre-commit install
We recommend developing within a local `Jupyter notebook server`_ environment.
In order to install and run it in the same virtual environment, execute the
following additional commands:

.. code::
.. code:: bash
pip install jupyter capellambse
cd docs/source/examples
jupyter-notebook
pip install jupyter capellambse
cd docs/source/examples
jupyter-notebook
If your browser did not open automatically, follow the instructions in the
terminal to start it manually.
Expand Down

0 comments on commit 1f45f10

Please sign in to comment.