Skip to content

Fix python version in community>Contributing #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gonzalesedwin1123 merged 2 commits into from
Sep 1, 2025
Merged

Fix python version in community>Contributing #72

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
60c72c1
Minor fix in community/contributing
gonzalesedwin1123 Sep 1, 2025
9d89e49
Updated contributing
gonzalesedwin1123 Sep 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions docs/community/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,19 +156,18 @@ steps below:
It is recommended that you use a virtual environment to build the documentation. This will allow you to
install the required dependencies without affecting your system.

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

@gemini-code-assist gemini-code-assist Bot Sep 1, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

Updating the recommended Python version to 3.11 is a good goal. However, requirements.txt contains libsass==0.20.1, which may cause installation issues on Python 3.11. This version of libsass lacks pre-built wheels for Python 3.10+, meaning contributors would need a C compiler and the libsass C library installed to build it from source. This could be a significant barrier to contribution.

To ensure a smooth setup process for contributors, please consider one of the following options:

  1. Update the libsass dependency to a more modern alternative that supports Python 3.11, such as dart-sass.
  2. Revert this change to recommend Python 3.10, for which pre-built wheels for libsass are available.


```bash
pip install -r requirements.txt
make html
```

### Synchronize the browser while editing

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

```shell
```bash
make livehtml
```

Expand Down Expand Up @@ -920,4 +919,4 @@ We use several Sphinx extensions to enhance the presentation of OpenSPP document
- [`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.
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/).
- [`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.
- [`sphinx.ext.autosummary`](https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html) generates function/method/attribute summary lists. -->
- [`sphinx.ext.autosummary`](https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html) generates function/method/attribute summary lists.