<commit_before>Workflow
========

Install
-------

To install the plugin from a git checkout,
run the following in a buildenv (Windows)::

  install.bat

or from a terminal (Linux)::

  sh install.sh

from within the ``blender_nif_plugin/install`` folder.

Run Regression Tests
--------------------

To run all tests, run the following in a buildenv (Windows)::

  blender-nosetests.bat

or from a terminal (Linux)::

  sh blender-nosetests.sh

from within the ``blender_nif_plugin/test`` folder.
This will test the currently installed plugin
(*not* your checked out version!)
so usually you would install it first.

Beware that the output can be rather verbose,
so you may have to scroll quite a bit to see the relevant backtrace.

Each test resides as a python file in the ``blender_nif_plugin/test/test`` folder.
To run a particular test only, specify the file as an argument; for instance::

  blender-nosetests.bat test/test_cube.py

Actually, all command line arguments of ``nosetests`` apply.
For example, to abort on first failure::

  blender-nosetests.bat -x

For more details, run::

  blender-nosetests.bat --help

Also see the
`nose manual <http://readthedocs.org/docs/nose/en/latest/usage.html#options>`_.

Generate Documentation
----------------------

Run the following in a buildenv (Windows) or terminal (Fedora)::

  make html

from within the ``blender_nif_plugin/docs`` folder.

To view the docs, open ``docs/_build/html/index.html``.<commit_msg>Also mention to install first before generating docs.<commit_after>Workflow
========

Install
-------

To install the plugin from a git checkout,
run the following in a buildenv (Windows)::

  install.bat

or from a terminal (Linux)::

  sh install.sh

from within the ``blender_nif_plugin/install`` folder.

Run Regression Tests
--------------------

To run all tests, run the following in a buildenv (Windows)::

  blender-nosetests.bat

or from a terminal (Linux)::

  sh blender-nosetests.sh

from within the ``blender_nif_plugin/test`` folder.
This will test the currently installed plugin
(*not* your checked out version!)
so usually you would install it first.

Beware that the output can be rather verbose,
so you may have to scroll quite a bit to see the relevant backtrace.

Each test resides as a python file in the ``blender_nif_plugin/test/test`` folder.
To run a particular test only, specify the file as an argument; for instance::

  blender-nosetests.bat test/test_cube.py

Actually, all command line arguments of ``nosetests`` apply.
For example, to abort on first failure::

  blender-nosetests.bat -x

For more details, run::

  blender-nosetests.bat --help

Also see the
`nose manual <http://readthedocs.org/docs/nose/en/latest/usage.html#options>`_.

Generate Documentation
----------------------

Run the following in a buildenv (Windows) or terminal (Fedora)::

  make html

from within the ``blender_nif_plugin/docs`` folder.
The generated API documentation
will correspond to the currently installed plugin
(*not* your checked out version!)
so usually you would install it first.

To view the docs, open ``docs/_build/html/index.html``.
{'fraction_non_alphanumeric': 0.11473314157877916, 'fraction_numerical': 0.0, 'mean_word_length': 3.706766917293233, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4306256', 'n_tokens_mistral': 947, 'n_tokens_neox': 899, 'n_words': 387}