Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update readme #384

Merged
merged 1 commit into from
Jan 19, 2024
Merged

update readme #384

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 3 additions & 9 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,15 +89,9 @@ Any questions: ask Reinout.
Schematisation checks list
--------------------------
A list of checks currently executed by the modelchecker is in current_schematisation_checks_table.
As new checks are added to the modelchecker, this table should be updated. To generate a new list,
install the `threedi-modelchecker <https://github.com/nens/threedi-modelchecker/>`_ (preferably in
a virtual environment), and run::

threedi_modelchecker export-checks --format rst --file i_current_schematisation_checks_table.rst

This will create a new file called ``i_current_schematisation_checks_table.rst`` in the directory in which
you run the command, with which you replace the existing ``i_current_schematisation_checks_table.rst``
file in the ``source`` directory in this repository.
As new checks are added to the modelchecker, this table should be updated. When a new version of the
modelchecker is released, a pull request to update the checks table will automatically be opened in
this repository, requesting a review from the person who created the modelchecker release.


Some commands needed for the OSGEO4W Shell with sphinx
Expand Down
Loading