Skip to content

Commit 12c4184

Browse files
author
Mauko Quiroga
committed
Add doc to make serve
1 parent 7024cba commit 12c4184

1 file changed

Lines changed: 13 additions & 1 deletion

File tree

Makefile

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,12 +77,24 @@ test: clean check-syntax-errors check-style check-types
7777
@##
7878
@## Examples:
7979
@##
80+
@## make test
8081
@## make test pytest_args="--exitfirst"
8182
@## make test openfisca_args="--performance"
8283
@## make test pytest_args="--exitfirst" openfisca_args="--performance"
8384
PYTEST_ADDOPTS="$$PYTEST_ADDOPTS ${pytest_args}" pytest
8485
PYTEST_ADDOPTS="$$PYTEST_ADDOPTS ${pytest_args}" openfisca test ${COUNTRY_TEMPLATE_TESTS} --country-package ${COUNTRY_TEMPLATE} ${openfisca_args}
8586
PYTEST_ADDOPTS="$$PYTEST_ADDOPTS ${pytest_args}" openfisca test ${EXTENSION_TEMPLATE_TESTS} --country-package ${COUNTRY_TEMPLATE} --extensions ${EXTENSION_TEMPLATE} ${openfisca_args}
8687

88+
## Serve the OpenFisca Web API.
8789
serve:
88-
openfisca serve -c ${COUNTRY_TEMPLATE} -e ${EXTENSION_TEMPLATE} ${optional_arguments}
90+
@## Usage:
91+
@##
92+
@## make serve [gunicorn_args="--ARG"] [openfisca_args="--ARG"]
93+
@##
94+
@## Examples:
95+
@##
96+
@## make serve
97+
@## make serve gunicorn_args="--workers 1"
98+
@## make serve openfisca_args="--welcome-message 'Hola :)'"
99+
@## make serve gunicorn_args="--workers 1" openfisca_args="--welcome-message 'Hola :)'"
100+
openfisca serve --country-package ${COUNTRY_TEMPLATE} --extensions ${EXTENSION_TEMPLATE} ${gunicorn_args} ${openfisca_args}

0 commit comments

Comments
 (0)