File tree Expand file tree Collapse file tree 5 files changed +23
-25
lines changed
Expand file tree Collapse file tree 5 files changed +23
-25
lines changed Original file line number Diff line number Diff line change 1515 "sphinx.ext.autodoc" ,
1616 "sphinx.ext.intersphinx" ,
1717 "sphinx.ext.napoleon" ,
18- "sphinx-prompt" ,
1918 "sphinx_substitution_extensions" ,
2019 "sphinxcontrib.spelling" ,
2120]
Original file line number Diff line number Diff line change @@ -10,39 +10,39 @@ Install contribution dependencies
1010
1111Install Python dependencies in a virtual environment.
1212
13- .. prompt :: bash
13+ .. code-block :: console
1414
15- pip install --editable '.[dev]'
15+ $ pip install --editable '.[dev]'
1616
1717 Spell checking requires ``enchant ``.
1818This can be installed on macOS, for example, with `Homebrew `_:
1919
20- .. prompt :: bash
20+ .. code-block :: console
2121
22- brew install enchant
22+ $ brew install enchant
2323
2424 and on Ubuntu with ``apt ``:
2525
26- .. prompt :: bash
26+ .. code-block :: console
2727
28- apt-get install -y enchant
28+ $ apt-get install -y enchant
2929
3030 Install ``pre-commit `` hooks:
3131
32- .. prompt :: bash
32+ .. code-block :: console
3333
34- pre-commit install
34+ $ pre-commit install
3535
3636 Linting
3737-------
3838
3939Run lint tools either by committing, or with:
4040
41- .. prompt :: bash
41+ .. code-block :: console
4242
43- pre-commit run --all-files --hook-stage commit --verbose
44- pre-commit run --all-files --hook-stage push --verbose
45- pre-commit run --all-files --hook-stage manual --verbose
43+ $ pre-commit run --all-files --hook-stage commit --verbose
44+ $ pre-commit run --all-files --hook-stage push --verbose
45+ $ pre-commit run --all-files --hook-stage manual --verbose
4646
4747 .. _Homebrew : https://brew.sh
4848
@@ -51,9 +51,9 @@ Running tests
5151
5252Run ``pytest ``:
5353
54- .. prompt :: bash
54+ .. code-block :: console
5555
56- pytest
56+ $ pytest
5757
5858 Documentation
5959-------------
@@ -62,10 +62,10 @@ Documentation is built on Read the Docs.
6262
6363Run the following commands to build and view documentation locally:
6464
65- .. prompt :: bash
65+ .. code-block :: console
6666
67- make docs
68- make open-docs
67+ $ make docs
68+ $ make open-docs
6969
7070 Continuous integration
7171----------------------
Original file line number Diff line number Diff line change 44Installation
55------------
66
7- .. prompt :: bash
7+ .. code-block :: console
88
9- pip3 install vws-python
9+ $ pip install vws-python
1010
1111 This is tested on Python 3.8+.
1212Get in touch with ``adamdangoor@gmail.com `` if you would like to use this with another language.
@@ -90,9 +90,9 @@ Testing
9090
9191To write unit tests for code which uses this library, without using your Vuforia quota, you can use the `VWS Python Mock `_ tool:
9292
93- .. prompt :: bash
93+ .. code-block :: console
9494
95- pip3 install vws-python-mock
95+ $ pip install vws-python-mock
9696
9797.. clear-namespace
9898
Original file line number Diff line number Diff line change @@ -14,9 +14,9 @@ Perform a Release
1414
1515#. Perform a release:
1616
17- .. prompt :: bash
17+ .. code-block :: console
1818 :substitutions:
1919
20- gh workflow run release.yml --repo |github-owner |/|github-repository |
20+ $ gh workflow run release.yml --repo |github-owner|/|github-repository|
2121
2222 .. _Install GitHub CLI : https://cli.github.com/
Original file line number Diff line number Diff line change @@ -59,7 +59,6 @@ optional-dependencies.dev = [
5959 " pyyaml==6.0.1" ,
6060 " ruff==0.5.5" ,
6161 " sphinx==7.4.7" ,
62- " sphinx-prompt==1.8" ,
6362 " sphinx-substitution-extensions==2024.2.25" ,
6463 " sphinxcontrib-spelling==8" ,
6564 " sybil==6.1.1" ,
You can’t perform that action at this time.
0 commit comments