Skip to content

Commit

Permalink
Deployed 9f1f12d with MkDocs version: 1.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
m4ra committed Aug 28, 2024
1 parent 8454c2d commit c1b484f
Show file tree
Hide file tree
Showing 18 changed files with 89 additions and 15 deletions.
2 changes: 2 additions & 0 deletions 404.html
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="/project_insights/">project insights</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/img_saving_and_deletion/">images</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/software_architecture/">architecture</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/tests/">tests</a>
Expand Down
2 changes: 2 additions & 0 deletions api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="../project_insights/">project insights</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../img_saving_and_deletion/">images</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../software_architecture/">architecture</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tests/">tests</a>
Expand Down
2 changes: 2 additions & 0 deletions celery/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="../project_insights/">project insights</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../img_saving_and_deletion/">images</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../software_architecture/">architecture</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tests/">tests</a>
Expand Down
2 changes: 2 additions & 0 deletions ckeditor/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="../project_insights/">project insights</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../img_saving_and_deletion/">images</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../software_architecture/">architecture</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tests/">tests</a>
Expand Down
2 changes: 2 additions & 0 deletions contributing/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="../project_insights/">project insights</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../img_saving_and_deletion/">images</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../software_architecture/">architecture</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tests/">tests</a>
Expand Down
2 changes: 2 additions & 0 deletions diagrams_modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="../project_insights/">project insights</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../img_saving_and_deletion/">images</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../software_architecture/">architecture</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tests/">tests</a>
Expand Down
2 changes: 2 additions & 0 deletions django_shell_basics/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="../project_insights/">project insights</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../img_saving_and_deletion/">images</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../software_architecture/">architecture</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tests/">tests</a>
Expand Down
2 changes: 2 additions & 0 deletions howtomkdocs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="../project_insights/">project insights</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../img_saving_and_deletion/">images</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../software_architecture/">architecture</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tests/">tests</a>
Expand Down
60 changes: 50 additions & 10 deletions img_saving_and_deletion/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,46 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../project_insights/">project insights</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="#">images</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#general-info">General info</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#api">API</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#users">Users</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#project">Project</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#organisation">Organisation</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#modules">Modules</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#idea">Idea</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#budgeting-mapidea-topicrio">Budgeting, MapIdea, Topicrio</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#budgeting">Budgeting</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#mapidea">MapIdea</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#topicrio">Topicrio</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#interactive-event">Interactive Event</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#offlineevent">OfflineEvent</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#debate">Debate</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#document">Document</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#poll">Poll</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#map">Map</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../software_architecture/">architecture</a>
</li>
Expand Down Expand Up @@ -177,9 +217,9 @@ <h2 id="users">Users</h2>
account_deletion # the namespace defined in the accounts.urls.py
</code></pre>
<h2 id="project">Project</h2>
<p>project's two images are saved under:</p>
<pre><code> &quot;media/projects/backgrounds&quot; # decorative background image
&quot;media/projects/tiles&quot; # project's tile image
<p>Image storage for projects is categorised by date, and a project's two images are saved under:</p>
<pre><code> &quot;media/projects/backgrounds/YYYY/MM/DD&quot; # decorative background image
&quot;media/projects/tiles/YYYY/MM/DD&quot; # project's tile image
</code></pre>
<p>project images are deleted when its organisation is deleted, and when the project is deleted via the user dashboard in the browser, which calls the endpoint: </p>
<pre><code>projects.views.ProjectDeleteView
Expand All @@ -194,8 +234,8 @@ <h2 id="organisation">Organisation</h2>
When an organisation is deleted, all its related projects with their modules get deleted too.</p>
<h2 id="modules">Modules</h2>
<h3 id="idea">Idea</h3>
<p>idea's image is saved under:</p>
<pre><code> &quot;media/ideas/images&quot;
<p>Image storage for ideas is categorised by date, and an idea's image is saved under:</p>
<pre><code> &quot;media/ideas/images/YYYY/MM/DD&quot;
</code></pre>
<p>idea image gets deleted when an idea is deleted via its idea detail page in the browser, which calls the endpoint:</p>
<pre><code>
Expand All @@ -207,7 +247,7 @@ <h3 id="idea">Idea</h3>
<h3 id="budgeting-mapidea-topicrio">Budgeting, MapIdea, Topicrio</h3>
<p>for those modules, images are deleted when the module is deleted either via the module page or the user dashboard.
Their deletion inherits from the AbstractIdeaDeleteView and their images are also uploaded to:</p>
<pre><code> &quot;media/ideas/images&quot;
<pre><code> &quot;media/ideas/images/YYYY/MM/DD&quot;
</code></pre>
<h3 id="budgeting">Budgeting</h3>
<p>Module is defined as Proposal and inherits from AbstractMapIdea, thus upload path is defined in the Parent class.
Expand Down Expand Up @@ -250,8 +290,8 @@ <h3 id="map">Map</h3>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../ckeditor/" class="btn btn-neutral float-left" title="ckeditor"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../project_insights/" class="btn btn-neutral float-right" title="project insights">Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../project_insights/" class="btn btn-neutral float-left" title="project insights"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../software_architecture/" class="btn btn-neutral float-right" title="architecture">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>

<hr/>
Expand All @@ -274,10 +314,10 @@ <h3 id="map">Map</h3>
<span class="rst-current-version" data-toggle="rst-current-version">


<span><a href="../ckeditor/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../project_insights/" style="color: #fcfcfc">&laquo; Previous</a></span>


<span><a href="../project_insights/" style="color: #fcfcfc">Next &raquo;</a></span>
<span><a href="../software_architecture/" style="color: #fcfcfc">Next &raquo;</a></span>

</span>
</div>
Expand Down
4 changes: 3 additions & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="project_insights/">project insights</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="img_saving_and_deletion/">images</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="software_architecture/">architecture</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="tests/">tests</a>
Expand Down Expand Up @@ -234,5 +236,5 @@ <h2 id="timelines_1"><a name="timelines">Timelines</a></h2>

<!--
MkDocs version : 1.6.0
Build Date UTC : 2024-08-28 12:41:56.351342+00:00
Build Date UTC : 2024-08-28 13:11:12.750928+00:00
-->
2 changes: 2 additions & 0 deletions installation_dev/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="../project_insights/">project insights</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../img_saving_and_deletion/">images</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../software_architecture/">architecture</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tests/">tests</a>
Expand Down
2 changes: 2 additions & 0 deletions installation_prod/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="../project_insights/">project insights</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../img_saving_and_deletion/">images</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../software_architecture/">architecture</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tests/">tests</a>
Expand Down
2 changes: 2 additions & 0 deletions languages_and_translations/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="../project_insights/">project insights</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../img_saving_and_deletion/">images</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../software_architecture/">architecture</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tests/">tests</a>
Expand Down
2 changes: 2 additions & 0 deletions management_commands/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="../project_insights/">project insights</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../img_saving_and_deletion/">images</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../software_architecture/">architecture</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tests/">tests</a>
Expand Down
6 changes: 4 additions & 2 deletions project_insights/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,8 @@
<li class="toctree-l2"><a class="reference internal" href="#migrations">migrations</a>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../img_saving_and_deletion/">images</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../software_architecture/">architecture</a>
</li>
Expand Down Expand Up @@ -166,7 +168,7 @@ <h2 id="developer-notes">Developer Notes</h2>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../img_saving_and_deletion/" class="btn btn-neutral float-left" title="images"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../software_architecture/" class="btn btn-neutral float-right" title="architecture">Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../img_saving_and_deletion/" class="btn btn-neutral float-right" title="images">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>

<hr/>
Expand All @@ -192,7 +194,7 @@ <h2 id="developer-notes">Developer Notes</h2>
<span><a href="../img_saving_and_deletion/" style="color: #fcfcfc">&laquo; Previous</a></span>


<span><a href="../software_architecture/" style="color: #fcfcfc">Next &raquo;</a></span>
<span><a href="../img_saving_and_deletion/" style="color: #fcfcfc">Next &raquo;</a></span>

</span>
</div>
Expand Down
2 changes: 2 additions & 0 deletions reference/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="../project_insights/">project insights</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../img_saving_and_deletion/">images</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../software_architecture/">architecture</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tests/">tests</a>
Expand Down
6 changes: 4 additions & 2 deletions software_architecture/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="../project_insights/">project insights</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../img_saving_and_deletion/">images</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="#">architecture</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#module-example-in-adhocracy">Module example in adhocracy+</a>
Expand Down Expand Up @@ -146,7 +148,7 @@ <h2 id="manual-and-glossary">Manual and Glossary</h2>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../project_insights/" class="btn btn-neutral float-left" title="project insights"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../img_saving_and_deletion/" class="btn btn-neutral float-left" title="images"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../tests/" class="btn btn-neutral float-right" title="tests">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>

Expand All @@ -170,7 +172,7 @@ <h2 id="manual-and-glossary">Manual and Glossary</h2>
<span class="rst-current-version" data-toggle="rst-current-version">


<span><a href="../project_insights/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../img_saving_and_deletion/" style="color: #fcfcfc">&laquo; Previous</a></span>


<span><a href="../tests/" style="color: #fcfcfc">Next &raquo;</a></span>
Expand Down
2 changes: 2 additions & 0 deletions tests/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="../project_insights/">project insights</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../img_saving_and_deletion/">images</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../software_architecture/">architecture</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="#">tests</a>
Expand Down

0 comments on commit c1b484f

Please sign in to comment.