Skip to content

Commit

Permalink
feat: add api blueprint to docs, fix styling with overflow
Browse files Browse the repository at this point in the history
  • Loading branch information
CheeseCake87 committed Aug 8, 2024
1 parent 30475bb commit 3920534
Show file tree
Hide file tree
Showing 42 changed files with 58 additions and 41 deletions.
10 changes: 10 additions & 0 deletions docs/_md/v5/CLI Commands-flask-imp blueprint.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,25 @@ Title = Generate a Flask-Imp Blueprint
Flask-Imp has its own type of blueprint. It can read some configuration from a toml file and has some extra methods for
auto importing.

You have the option to generate a regular template rendering blueprint, or a API blueprint that returns a JSON response.

```bash
flask-imp blueprint --help
```
or
```bash
flask-imp api-blueprint --help
```

To generate a Flask-Imp blueprint, run the following command:

```bash
flask-imp blueprint
```
or
```bash
flask-imp api-blueprint
```

After running this command, you will be prompted to enter the location of where you want to create your blueprint:

Expand Down
2 changes: 1 addition & 1 deletion docs/v3/static/water.css
Original file line number Diff line number Diff line change
Expand Up @@ -662,7 +662,7 @@ time {
}

pre {
overflow-x: scroll;
overflow-x: auto;
}

pre > code {
Expand Down
2 changes: 1 addition & 1 deletion docs/v4/static/water.css
Original file line number Diff line number Diff line change
Expand Up @@ -662,7 +662,7 @@ time {
}

pre {
overflow-x: scroll;
overflow-x: auto;
}

pre > code {
Expand Down
9 changes: 8 additions & 1 deletion docs/v5/cli_commands-flask-imp_blueprint.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down Expand Up @@ -248,11 +248,18 @@ <h2>Menu</h2>
<h1 style="font-size: 2.6rem; margin: 0;">Generate a Flask-Imp Blueprint</h1>
<p>Flask-Imp has its own type of blueprint. It can read some configuration from a toml file and has some extra methods for
auto importing.</p>
<p>You have the option to generate a regular template rendering blueprint, or a API blueprint that returns a JSON response.</p>
<div class="highlight"><pre><span></span>flask-imp<span class="w"> </span>blueprint<span class="w"> </span>--help
</pre></div>
<p>or</p>
<div class="highlight"><pre><span></span>flask-imp<span class="w"> </span>api-blueprint<span class="w"> </span>--help
</pre></div>
<p>To generate a Flask-Imp blueprint, run the following command:</p>
<div class="highlight"><pre><span></span>flask-imp<span class="w"> </span>blueprint
</pre></div>
<p>or</p>
<div class="highlight"><pre><span></span>flask-imp<span class="w"> </span>api-blueprint
</pre></div>
<p>After running this command, you will be prompted to enter the location of where you want to create your blueprint:</p>
<div class="highlight"><pre><span></span>~ $ flask-imp blueprint
(Creation is relative to the current working directory)
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/cli_commands-flask-imp_init.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/flask_imp_auth-authenticate_password.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/flask_imp_auth-encrypt_password.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/flask_imp_auth-generate_csrf_token.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/flask_imp_auth-generate_email_validator.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/flask_imp_auth-generate_numeric_validator.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/flask_imp_auth-generate_password.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/flask_imp_auth-generate_private_key.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/flask_imp_auth-generate_salt.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/flask_imp_auth-is_email_address_valid.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/flask_imp_auth-is_username_valid.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/flask_imp_config-databaseconfig.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/flask_imp_config-flaskconfig.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/flask_imp_config-impblueprintconfig.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/flask_imp_config-impconfig.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/flask_imp_security-api_login_check.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/flask_imp_security-include_csrf.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/flask_imp_security-login_check.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/flask_imp_security-pass_function_check.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/flask_imp_security-permission_check.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/imp-import_app_resources.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/imp-import_blueprint.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/imp-import_blueprints.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/imp-import_models.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/imp-init_app-init.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/imp-init_session.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/imp-introduction.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/imp-model.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/impblueprint-import_models.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/impblueprint-import_nested_blueprint.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/impblueprint-import_nested_blueprints.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/impblueprint-import_resources.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/impblueprint-init.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/impblueprint-introduction.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/impblueprint-tmpl.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<h1>Flask-Imp</h1>
<div><small>Version: 5.0.x</small></div>
<div><small>Last Updated:</small></div>
<div><small>Tue, 06 Aug 2024</small></div>
<div><small>Thu, 08 Aug 2024</small></div>

<p><a href="../v4/index.html">Switch to version 4 docs</a></p>
<p><a href="../v3/index.html">Switch to version 3 docs</a></p>
Expand Down
Loading

0 comments on commit 3920534

Please sign in to comment.