diff --git a/README.md b/README.md index b142c915..d9aa9465 100644 --- a/README.md +++ b/README.md @@ -101,8 +101,7 @@ python -m venv venv ### Install the requirements. ```bash -pip install -r requirements.txt -pip install -r requirements_dev.txt +pip install -r requirements/development.txt ``` ### Install the local version of Flask-Imp. @@ -141,10 +140,12 @@ The tests are linked to the tests blueprint located at `test_app/blueprints/test ### Building the docs. -All docs are generated from the [docs_md](docs_md) folder. Edit these files then run the following command to generate the docs. +All docs are generated from the [docs](docs) folder. + +Edit these files, then run the following command to generate the docs. ```bash -flask --app gdocs compile +flask --app docs compile ``` You can set it to watch for changes and automatically recompile the docs by adding the `--watch` flag. diff --git a/docs/md/v4/Imp_x-init_app-init.md b/docs/md/v4/Imp_x-init_app-init.md index fd923fa1..bdf0a4fb 100644 --- a/docs/md/v4/Imp_x-init_app-init.md +++ b/docs/md/v4/Imp_x-init_app-init.md @@ -30,8 +30,3 @@ If `config.toml` is not found, an attempt to load a class called `Config` from ` The Config class must be an instance of `ImpConfig` `from flask_imp import ImpConfig`. An exception will be raised if none of the above methods are successful. - -If `ignore_missing_env_variables` is `True`, then missing environment variables will be ignored. - -If `ignore_missing_env_variables` is `False` (default), then missing environment variables will raise a ValueError - diff --git a/docs/v4/imp_x-init_app-init.html b/docs/v4/imp_x-init_app-init.html index 16806381..5d4af941 100644 --- a/docs/v4/imp_x-init_app-init.html +++ b/docs/v4/imp_x-init_app-init.html @@ -267,8 +267,6 @@
If config.toml
is not found, an attempt to load a class called Config
from config.py
will be made.
The Config class must be an instance of ImpConfig
from flask_imp import ImpConfig
.
An exception will be raised if none of the above methods are successful.
-If ignore_missing_env_variables
is True
, then missing environment variables will be ignored.
If ignore_missing_env_variables
is False
(default), then missing environment variables will raise a ValueError