Skip to content

Commit

Permalink
docs: fix to init_app, readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
CheeseCake87 committed May 13, 2024
1 parent a3e0c20 commit 0c596de
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 11 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
5 changes: 0 additions & 5 deletions docs/md/v4/Imp_x-init_app-init.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

2 changes: 0 additions & 2 deletions docs/v4/imp_x-init_app-init.html
Original file line number Diff line number Diff line change
Expand Up @@ -267,8 +267,6 @@ <h1 style="font-size: 2.6rem; margin: 0;">Imp.init_app, __init__</h1>
<p>If <code>config.toml</code> is not found, an attempt to load a class called <code>Config</code> from <code>config.py</code> will be made.
The Config class must be an instance of <code>ImpConfig</code> <code>from flask_imp import ImpConfig</code>.</p>
<p>An exception will be raised if none of the above methods are successful.</p>
<p>If <code>ignore_missing_env_variables</code> is <code>True</code>, then missing environment variables will be ignored.</p>
<p>If <code>ignore_missing_env_variables</code> is <code>False</code> (default), then missing environment variables will raise a ValueError</p>

</section>

Expand Down

0 comments on commit 0c596de

Please sign in to comment.