With its little mind tries very hard to check whether documentation is compliant with the SUSE Documentation Style Guide.
Releases are usually aligned with releases of the Style Guide.
-
To use SDSC from this Git repository, set up a Python 3 Virtual Environment
-
On openSUSE systems, you can install the RPM version of SDSC from the Documentation:Tools project
- Create a new Python environment with the command:
python3 -m venv .env
- Activate the environment with:
source .env/bin/activate
- Update the environment:
pip3 install --upgrade pip setuptools
- "Install" the SUSE stylechecker inside the environment with:
./setup.py develop
- Use any existing XML file for testing:
sdsc <XML_FILE>
- To compare with the system stylechecker, use the absolute path to the script like:
/usr/bin/sdsc <XML_FILE>
To get rid of the environment in your GitHub repo, execute these final steps:
- Deactivate the environment first:
deactivate
- Remove the .env folder with:
rm -rf .env
