Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Marcus Burghardt <[email protected]>
  • Loading branch information
vojtapolasek and marcusburghardt authored Dec 2, 2024
1 parent facdf44 commit 1d7801c
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/manual/developer/05_tools_and_utilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ this easier: `.pyenv.sh`. To set `PYTHONPATH` correctly for the current
shell, simply call `source .pyenv.sh`. For more information on how to
use this script, please see the comments at the top of the file.

It is also possible to install the module with pip.
Please note that this possibility was added after releasing the 0.1.75 version.
To install the ssg module s it is currently present in the master branch, run the following command (possibly within a Python virtual environment):
It is also possible to install the module with `pip`. In this case it is recommended to install it within a Python virtual environment.
Please note that this possibility was added after releasing the 0.1.75 version and until the release 0.1.76 is out it can only be installed from `master` branch.
To install the ssg module currently present in the master branch, run the following command:
```bash
pip install git+https://github.com/ComplianceasCode/content
```
Expand All @@ -21,12 +21,12 @@ This is recommended because the library is not stable and it can change unexpect
This is an example command which installs the library associated with the 0.1.76 release:

```bash
pip install git+https://github.com/ComplianceasCode/[email protected].75
pip install git+https://github.com/ComplianceasCode/[email protected].76
```

The installed package is named `ssg`.
Please note that the name of the package will very probably change in the future.
Therefore, if you install the module in this way, please pay close attention to release notes.
Therefore, if you install the module this way, please pay close attention to the release notes.
It is worth emphasizing here that stability of the module is not guaranteed.
Currently, it is used mainly for building the content and it is therefore modified predominantly based on needs of the content build system.

Expand Down

0 comments on commit 1d7801c

Please sign in to comment.