Skip to content

Commit d8255d6

Browse files
Merge pull request #72 from OpenSPP/review-documents-edwin
Fix python version in community>Contributing
2 parents da7e9d5 + 9d89e49 commit d8255d6

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

docs/community/contributing.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -156,19 +156,18 @@ steps below:
156156
It is recommended that you use a virtual environment to build the documentation. This will allow you to
157157
install the required dependencies without affecting your system.
158158

159-
Python 3.10 should be used to build the documentation. You can install it using your package manager or by
159+
Python 3.11 should be used to build the documentation. You can install it using your package manager or by
160160
following the instructions on the [pyenv GitHub page](https://github.com/pyenv/pyenv).
161161

162162
```bash
163-
pip install -r requirements.txt
164163
make html
165164
```
166165

167166
### Synchronize the browser while editing
168167

169168
Use `sphinx-autobuild` to view changes in the browser while you edit documentation.
170169

171-
```shell
170+
```bash
172171
make livehtml
173172
```
174173

@@ -920,4 +919,4 @@ We use several Sphinx extensions to enhance the presentation of OpenSPP document
920919
- [`sphinxcontrib.httpexample`](https://sphinxcontrib-httpexample.readthedocs.io/en/latest/) enhances `sphinxcontrib-httpdomain` by generating RESTful HTTP API call examples for different tools from a single HTTP request example.
921920
Supported tools include [curl](https://curl.se/), [wget](https://www.gnu.org/software/wget/), [httpie](https://httpie.io/), and [python-requests](https://requests.readthedocs.io/en/latest/).
922921
- [`sphinx.ext.viewcode`](https://www.sphinx-doc.org/en/master/usage/extensions/viewcode.html) generates pages of source code modules and links between the source and the description.
923-
- [`sphinx.ext.autosummary`](https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html) generates function/method/attribute summary lists. -->
922+
- [`sphinx.ext.autosummary`](https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html) generates function/method/attribute summary lists.

0 commit comments

Comments
 (0)