@@ -149,7 +149,7 @@ isolated Python virtual environment. To install Tox, run:
149149 python -m pip install tox
150150
151151 Finally, verify the installation by listing all the different environments
152- (automation rules) for PySTK :
152+ (automation rules) for Ansys Sphinx theme :
153153
154154.. code-block :: text
155155
@@ -172,3 +172,40 @@ Finally, verify the installation by listing all the different environments
172172 * - {{ name }}
173173 - {{ description }}
174174 {% endfor %}
175+
176+
177+ Adhere to code style
178+ --------------------
179+
180+ Ansys Sphinx theme follows the PEP8 standard as outlined in
181+ `PEP 8 <https://dev.docs.pyansys.com/coding-style/pep8.html >`_ in
182+ the *PyAnsys Developer's Guide * and implements style checking using
183+ `pre-commit <https://pre-commit.com/ >`_.
184+
185+ To ensure your code meets minimum code styling standards, run these commands::
186+
187+ pip install pre-commit
188+ pre-commit run --all-files
189+
190+ or use tox as above::
191+
192+ tox -e code-style
193+
194+ You can also install this as a pre-commit hook by running this command::
195+
196+ pre-commit install
197+
198+ This way, it's not possible for you to push code that fails the style checks::
199+
200+ $ pre-commit install
201+ $ git commit -am "added my cool feature"
202+ ruff.....................................................................Passed
203+ ruff-format..............................................................Passed
204+ codespell................................................................Passed
205+ prettier.................................................................Passed
206+ check for merge conflicts................................................Passed
207+ debug statements (python)................................................Passed
208+ check yaml...............................................................Passed
209+ trim trailing whitespace.................................................Passed
210+ Validate GitHub Workflows................................................Passed
211+ Add License Headers......................................................Passed
0 commit comments