Skip to content
Snippets Groups Projects
Unverified Commit 37a95fda authored by Andrea Franchini's avatar Andrea Franchini
Browse files

update docs

parent ab500a5a
No related branches found
No related tags found
No related merge requests found
...@@ -7,19 +7,24 @@ First, you'll need to install the dependencies to run this tool. ...@@ -7,19 +7,24 @@ First, you'll need to install the dependencies to run this tool.
Installing the dependencies Installing the dependencies
=========================== ===========================
1. Clone/download the model checker repository.
This project is packaged with `Poetry`_, so you should install it first. 2. Setting up a Python virtual environment is recommended. You can run the following command to create it::
Once *Poetry* has been installed, install the dependencies with:: python -m venv .venv
poetry install # Remember to activate it! e.g.:
source .venv/bin/activate
3. Install the dependencies with::
pip install -r requirements.txt
Run locally for testing Run locally for testing
----------------------- -----------------------
Run with:: Run with::
poetry run python -m mc_openapi python -m mc_openapi
This command serves the APIs through a `Flask`_ instance, This command serves the APIs through a `Flask`_ instance,
which is suitable for testing, but not recommended for production. which is suitable for testing, but not recommended for production.
...@@ -64,11 +69,7 @@ Building the Documentation ...@@ -64,11 +69,7 @@ Building the Documentation
The documentation has been written in `Sphinx`_. The documentation has been written in `Sphinx`_.
To build it, type:: To build it manually, run::
poetry shell
and then::
cd docs cd docs
make html make html
...@@ -76,7 +77,6 @@ and then:: ...@@ -76,7 +77,6 @@ and then::
The documentation will be generated in ``docs/_build``. The documentation will be generated in ``docs/_build``.
.. _Poetry: https://python-poetry.org/
.. _Flask: https://flask.palletsprojects.com/ .. _Flask: https://flask.palletsprojects.com/
.. _Swagger-UI: https://swagger.io/tools/swagger-ui/ .. _Swagger-UI: https://swagger.io/tools/swagger-ui/
.. _Uvicorn: https://www.uvicorn.org/ .. _Uvicorn: https://www.uvicorn.org/
......
...@@ -3,8 +3,10 @@ Testing ...@@ -3,8 +3,10 @@ Testing
To run the tests with *PyTest* you'll need to setup the server:: To run the tests with *PyTest* you'll need to setup the server::
poetry run python -m mc_openapi python -m mc_openapi
and then run separately:: and then run separately::
poetry run python -m pytest python -m pytest
Currently, a few tests are run for each supported DOML version.
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment