Skip to content

openSUSE/suse-doc-style-checker

Repository files navigation

SUSE Documentation Style Checker

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.

Usage

Testing the branch

  1. Create a new Python environment with the command:
    python3 -m venv .env
  2. Activate the environment with:
    source .env/bin/activate
  3. Update the environment:
    pip3 install --upgrade pip setuptools
  4. "Install" the SUSE stylechecker inside the environment with:
    ./setup.py develop
  5. Use any existing XML file for testing:
    sdsc <XML_FILE>
  6. 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:

  1. Deactivate the environment first:
    deactivate
  2. Remove the .env folder with:
    rm -rf .env

Lucky Charms

Build Status Coverage Status Scrutinizer Code Quality