Skip to content

Commit

Permalink
Working on docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@CheeseCake87
CheeseCake87 committed Nov 1, 2023
1 parent 9b5e3e7 commit da80992
Show file tree
Hide file tree
Showing 52 changed files with 1,114 additions and 648 deletions.
24 changes: 14 additions & 10 deletions docs/blueprint-config-toml.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<img width="50%" src="static/Flask-Imp-Medium.png" alt="Flask-Imp Logo" style="margin-top: 20px;">
<h1>Flask-Imp</h1>
<div><small>Last Updated:</small></div>
<div><small>Tue, 31 Oct 2023</small></div>
<div><small>Wed, 01 Nov 2023</small></div>

<h2>Menu</h2>
<ul>
Expand All @@ -31,7 +31,7 @@ <h2>Menu</h2>
<li><strong>CLI Commands</strong></li>


<ul style="padding-top: 5px; padding-left: 10px;">
<ul>


<li><a href="cli_commands-flask-imp_init.html">flask-imp init</a></li>
Expand All @@ -48,7 +48,7 @@ <h2>Menu</h2>
<li><strong>Imp</strong></li>


<ul style="padding-top: 5px; padding-left: 10px;">
<ul>


<li><a href="imp-introduction.html">Introduction</a></li>
Expand All @@ -69,7 +69,7 @@ <h2>Menu</h2>
<li><strong>Blueprint</strong></li>


<ul style="padding-top: 5px; padding-left: 10px;">
<ul>


<li><a href="blueprint-introduction.html">Introduction</a></li>
Expand All @@ -86,10 +86,10 @@ <h2>Menu</h2>
<li><strong>Imp.x</strong></li>


<ul style="padding-top: 5px; padding-left: 10px;">
<ul>


<li><a href="imp_x-init_app.html">init_app</a></li>
<li><a href="imp_x-init_app-init.html">init_app, __init__</a></li>



Expand Down Expand Up @@ -125,7 +125,11 @@ <h2>Menu</h2>
<li><strong>Blueprint.x</strong></li>


<ul style="padding-top: 5px; padding-left: 10px;">
<ul>


<li><a href="blueprint-init.html">__init__</a></li>



<li><a href="blueprint_x-init_session.html">init_session</a></li>
Expand Down Expand Up @@ -158,7 +162,7 @@ <h2>Menu</h2>
<li><strong>flask_imp.security</strong></li>


<ul style="padding-top: 5px; padding-left: 10px;">
<ul>


<li><a href="flask_imp_security-login_check.html">login_check</a></li>
Expand Down Expand Up @@ -187,7 +191,7 @@ <h2>Menu</h2>
<li><strong>flask_imp.auth</strong></li>


<ul style="padding-top: 5px; padding-left: 10px;">
<ul>


<li><a href="flask_imp_auth-is_email_address_valid.html">is_email_address_valid</a></li>
Expand Down Expand Up @@ -267,7 +271,7 @@ <h1 style="font-size: 2.6rem; margin: 0;">The Flask-Imp Blueprint Config File</h
enable/disable the Blueprint, and set session variables.</p>
<p>For more information about the args of a regular Flask Blueprint see:
<a href="https://flask.palletsprojects.com/en/3.0.x/api/#flask.Blueprint">Flask docs (Blueprint)</a></p>
<h4>Example of advance use case for blueprint config files:</h4>
<h5>Example of advance use case for blueprint config files:</h5>
<div class="highlight"><pre><span></span>testing_blueprint/
├── routes/
│ └── index.py
Expand Down
27 changes: 14 additions & 13 deletions docs/blueprint-introduction.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<img width="50%" src="static/Flask-Imp-Medium.png" alt="Flask-Imp Logo" style="margin-top: 20px;">
<h1>Flask-Imp</h1>
<div><small>Last Updated:</small></div>
<div><small>Tue, 31 Oct 2023</small></div>
<div><small>Wed, 01 Nov 2023</small></div>

<h2>Menu</h2>
<ul>
Expand All @@ -31,7 +31,7 @@ <h2>Menu</h2>
<li><strong>CLI Commands</strong></li>


<ul style="padding-top: 5px; padding-left: 10px;">
<ul>


<li><a href="cli_commands-flask-imp_init.html">flask-imp init</a></li>
Expand All @@ -48,7 +48,7 @@ <h2>Menu</h2>
<li><strong>Imp</strong></li>


<ul style="padding-top: 5px; padding-left: 10px;">
<ul>


<li><a href="imp-introduction.html">Introduction</a></li>
Expand All @@ -69,7 +69,7 @@ <h2>Menu</h2>
<li><strong>Blueprint</strong></li>


<ul style="padding-top: 5px; padding-left: 10px;">
<ul>


<li><a href="blueprint-introduction.html">Introduction</a></li>
Expand All @@ -86,10 +86,10 @@ <h2>Menu</h2>
<li><strong>Imp.x</strong></li>


<ul style="padding-top: 5px; padding-left: 10px;">
<ul>


<li><a href="imp_x-init_app.html">init_app</a></li>
<li><a href="imp_x-init_app-init.html">init_app, __init__</a></li>



Expand Down Expand Up @@ -125,7 +125,11 @@ <h2>Menu</h2>
<li><strong>Blueprint.x</strong></li>


<ul style="padding-top: 5px; padding-left: 10px;">
<ul>


<li><a href="blueprint-init.html">__init__</a></li>



<li><a href="blueprint_x-init_session.html">init_session</a></li>
Expand Down Expand Up @@ -158,7 +162,7 @@ <h2>Menu</h2>
<li><strong>flask_imp.security</strong></li>


<ul style="padding-top: 5px; padding-left: 10px;">
<ul>


<li><a href="flask_imp_security-login_check.html">login_check</a></li>
Expand Down Expand Up @@ -187,7 +191,7 @@ <h2>Menu</h2>
<li><strong>flask_imp.auth</strong></li>


<ul style="padding-top: 5px; padding-left: 10px;">
<ul>


<li><a href="flask_imp_auth-is_email_address_valid.html">is_email_address_valid</a></li>
Expand Down Expand Up @@ -245,10 +249,7 @@ <h2>Menu</h2>

<section>
<h1 style="font-size: 2.6rem; margin: 0;">Flask-Imp Blueprint Introduction</h1>
<div class="highlight"><pre><span></span><span class="n">Blueprint</span><span class="p">(</span><span class="n">dunder_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">config_file</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;config.toml&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</pre></div>
<hr />
<p>The Flask-Imp Blueprint inherits from the Flask Blueprint class, then adds some additional methods to allow for auto
<p>The Flask-Imp Blueprint inherits from the Flask Blueprint class, then adds some additional methods to allow for auto
importing of models, resources and other nested blueprints.</p>
<p>The Flask-Imp Blueprint reads configuration from a config.toml file, which is located in the same directory as the
<code>__init__.py</code> file.</p>
Expand Down
22 changes: 13 additions & 9 deletions docs/blueprint_x-import_models.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<img width="50%" src="static/Flask-Imp-Medium.png" alt="Flask-Imp Logo" style="margin-top: 20px;">
<h1>Flask-Imp</h1>
<div><small>Last Updated:</small></div>
<div><small>Tue, 31 Oct 2023</small></div>
<div><small>Wed, 01 Nov 2023</small></div>

<h2>Menu</h2>
<ul>
Expand All @@ -31,7 +31,7 @@ <h2>Menu</h2>
<li><strong>CLI Commands</strong></li>


<ul style="padding-top: 5px; padding-left: 10px;">
<ul>


<li><a href="cli_commands-flask-imp_init.html">flask-imp init</a></li>
Expand All @@ -48,7 +48,7 @@ <h2>Menu</h2>
<li><strong>Imp</strong></li>


<ul style="padding-top: 5px; padding-left: 10px;">
<ul>


<li><a href="imp-introduction.html">Introduction</a></li>
Expand All @@ -69,7 +69,7 @@ <h2>Menu</h2>
<li><strong>Blueprint</strong></li>


<ul style="padding-top: 5px; padding-left: 10px;">
<ul>


<li><a href="blueprint-introduction.html">Introduction</a></li>
Expand All @@ -86,10 +86,10 @@ <h2>Menu</h2>
<li><strong>Imp.x</strong></li>


<ul style="padding-top: 5px; padding-left: 10px;">
<ul>


<li><a href="imp_x-init_app.html">init_app</a></li>
<li><a href="imp_x-init_app-init.html">init_app, __init__</a></li>



Expand Down Expand Up @@ -125,7 +125,11 @@ <h2>Menu</h2>
<li><strong>Blueprint.x</strong></li>


<ul style="padding-top: 5px; padding-left: 10px;">
<ul>


<li><a href="blueprint-init.html">__init__</a></li>



<li><a href="blueprint_x-init_session.html">init_session</a></li>
Expand Down Expand Up @@ -158,7 +162,7 @@ <h2>Menu</h2>
<li><strong>flask_imp.security</strong></li>


<ul style="padding-top: 5px; padding-left: 10px;">
<ul>


<li><a href="flask_imp_security-login_check.html">login_check</a></li>
Expand Down Expand Up @@ -187,7 +191,7 @@ <h2>Menu</h2>
<li><strong>flask_imp.auth</strong></li>


<ul style="padding-top: 5px; padding-left: 10px;">
<ul>


<li><a href="flask_imp_auth-is_email_address_valid.html">is_email_address_valid</a></li>
Expand Down
22 changes: 13 additions & 9 deletions docs/blueprint_x-import_nested_blueprint.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<img width="50%" src="static/Flask-Imp-Medium.png" alt="Flask-Imp Logo" style="margin-top: 20px;">
<h1>Flask-Imp</h1>
<div><small>Last Updated:</small></div>
<div><small>Tue, 31 Oct 2023</small></div>
<div><small>Wed, 01 Nov 2023</small></div>

<h2>Menu</h2>
<ul>
Expand All @@ -31,7 +31,7 @@ <h2>Menu</h2>
<li><strong>CLI Commands</strong></li>


<ul style="padding-top: 5px; padding-left: 10px;">
<ul>


<li><a href="cli_commands-flask-imp_init.html">flask-imp init</a></li>
Expand All @@ -48,7 +48,7 @@ <h2>Menu</h2>
<li><strong>Imp</strong></li>


<ul style="padding-top: 5px; padding-left: 10px;">
<ul>


<li><a href="imp-introduction.html">Introduction</a></li>
Expand All @@ -69,7 +69,7 @@ <h2>Menu</h2>
<li><strong>Blueprint</strong></li>


<ul style="padding-top: 5px; padding-left: 10px;">
<ul>


<li><a href="blueprint-introduction.html">Introduction</a></li>
Expand All @@ -86,10 +86,10 @@ <h2>Menu</h2>
<li><strong>Imp.x</strong></li>


<ul style="padding-top: 5px; padding-left: 10px;">
<ul>


<li><a href="imp_x-init_app.html">init_app</a></li>
<li><a href="imp_x-init_app-init.html">init_app, __init__</a></li>



Expand Down Expand Up @@ -125,7 +125,11 @@ <h2>Menu</h2>
<li><strong>Blueprint.x</strong></li>


<ul style="padding-top: 5px; padding-left: 10px;">
<ul>


<li><a href="blueprint-init.html">__init__</a></li>



<li><a href="blueprint_x-init_session.html">init_session</a></li>
Expand Down Expand Up @@ -158,7 +162,7 @@ <h2>Menu</h2>
<li><strong>flask_imp.security</strong></li>


<ul style="padding-top: 5px; padding-left: 10px;">
<ul>


<li><a href="flask_imp_security-login_check.html">login_check</a></li>
Expand Down Expand Up @@ -187,7 +191,7 @@ <h2>Menu</h2>
<li><strong>flask_imp.auth</strong></li>


<ul style="padding-top: 5px; padding-left: 10px;">
<ul>


<li><a href="flask_imp_auth-is_email_address_valid.html">is_email_address_valid</a></li>
Expand Down
Loading

0 comments on commit da80992

Please sign in to comment.