Skip to content
This repository has been archived by the owner on Mar 10, 2021. It is now read-only.

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jamonholmgren committed Jan 15, 2019
1 parent d74c21c commit edb7ccf
Show file tree
Hide file tree
Showing 22 changed files with 124 additions and 102 deletions.
1 change: 1 addition & 0 deletions doc/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
<meta name="generator" content="ExDoc v0.19.2">
<title>404 — thesis v0.3.2</title>
<link rel="stylesheet" href="dist/html-c1666276880c0f8e3769.css" />
<link rel="canonical" href="https://hexdocs.pm/thesis/404.html" />
<script src="dist/sidebar_items-faefb02862.js"></script>

</head>
Expand Down
1 change: 1 addition & 0 deletions doc/Mix.Tasks.Thesis.Install.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
<meta name="generator" content="ExDoc v0.19.2">
<title>thesis.install — thesis v0.3.2</title>
<link rel="stylesheet" href="dist/html-c1666276880c0f8e3769.css" />
<link rel="canonical" href="https://hexdocs.pm/thesis/Mix.Tasks.Thesis.Install.html" />
<script src="dist/sidebar_items-faefb02862.js"></script>

</head>
Expand Down
11 changes: 6 additions & 5 deletions doc/Thesis.Auth.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
<meta name="generator" content="ExDoc v0.19.2">
<title>Thesis.Auth — thesis v0.3.2</title>
<link rel="stylesheet" href="dist/html-c1666276880c0f8e3769.css" />
<link rel="canonical" href="https://hexdocs.pm/thesis/Thesis.Auth.html" />
<script src="dist/sidebar_items-faefb02862.js"></script>

</head>
Expand Down Expand Up @@ -124,14 +125,14 @@ <h1 class="signature">page_is_editable?(arg0)</span>
whether to load and display the Thesis editor and also whether to allow
updates to Thesis.Page and Thesis.PageContent areas.</p>
<p>Typical example:</p>
<pre><code class="nohighlight makeup elixir"><span class="kd">defmodule</span><span class="w"> </span><span class="nc">MyApp.ThesisAuth</span><span class="w"> </span><span class="k" data-group-id="6355458527-1">do</span><span class="w">
<pre><code class="nohighlight makeup elixir"><span class="kd">defmodule</span><span class="w"> </span><span class="nc">MyApp.ThesisAuth</span><span class="w"> </span><span class="k" data-group-id="7911432270-1">do</span><span class="w">
</span><span class="na">@behaviour</span><span class="w"> </span><span class="nc">Thesis.Auth</span><span class="w">

</span><span class="kd">def</span><span class="w"> </span><span class="nf">page_is_editable?</span><span class="p" data-group-id="6355458527-2">(</span><span class="n">conn</span><span class="p" data-group-id="6355458527-2">)</span><span class="w"> </span><span class="k" data-group-id="6355458527-3">do</span><span class="w">
</span><span class="kd">def</span><span class="w"> </span><span class="nf">page_is_editable?</span><span class="p" data-group-id="7911432270-2">(</span><span class="n">conn</span><span class="p" data-group-id="7911432270-2">)</span><span class="w"> </span><span class="k" data-group-id="7911432270-3">do</span><span class="w">
</span><span class="n">conn</span><span class="w">
</span><span class="o">|&gt;</span><span class="w"> </span><span class="nc">MyApp.AuthController</span><span class="o">.</span><span class="n">current_user_is_admin?</span><span class="p" data-group-id="6355458527-4">(</span><span class="n">conn</span><span class="p" data-group-id="6355458527-4">)</span><span class="w">
</span><span class="k" data-group-id="6355458527-3">end</span><span class="w">
</span><span class="k" data-group-id="6355458527-1">end</span></code></pre>
</span><span class="o">|&gt;</span><span class="w"> </span><span class="nc">MyApp.AuthController</span><span class="o">.</span><span class="n">current_user_is_admin?</span><span class="p" data-group-id="7911432270-4">(</span><span class="n">conn</span><span class="p" data-group-id="7911432270-4">)</span><span class="w">
</span><span class="k" data-group-id="7911432270-3">end</span><span class="w">
</span><span class="k" data-group-id="7911432270-1">end</span></code></pre>
</section>
</section>
</div>
Expand Down
1 change: 1 addition & 0 deletions doc/Thesis.Backup.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
<meta name="generator" content="ExDoc v0.19.2">
<title>Thesis.Backup — thesis v0.3.2</title>
<link rel="stylesheet" href="dist/html-c1666276880c0f8e3769.css" />
<link rel="canonical" href="https://hexdocs.pm/thesis/Thesis.Backup.html" />
<script src="dist/sidebar_items-faefb02862.js"></script>

</head>
Expand Down
1 change: 1 addition & 0 deletions doc/Thesis.Controller.Plug.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
<meta name="generator" content="ExDoc v0.19.2">
<title>Thesis.Controller.Plug — thesis v0.3.2</title>
<link rel="stylesheet" href="dist/html-c1666276880c0f8e3769.css" />
<link rel="canonical" href="https://hexdocs.pm/thesis/Thesis.Controller.Plug.html" />
<script src="dist/sidebar_items-faefb02862.js"></script>

</head>
Expand Down
11 changes: 6 additions & 5 deletions doc/Thesis.Controller.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
<meta name="generator" content="ExDoc v0.19.2">
<title>Thesis.Controller — thesis v0.3.2</title>
<link rel="stylesheet" href="dist/html-c1666276880c0f8e3769.css" />
<link rel="canonical" href="https://hexdocs.pm/thesis/Thesis.Controller.html" />
<script src="dist/sidebar_items-faefb02862.js"></script>

</head>
Expand Down Expand Up @@ -66,16 +67,16 @@ <h1>
<p>Provides a plug that preloads any Thesis content for a page.
Typically, you&#39;ll add this to your <code class="inline">web/web.ex</code> file, under the <code class="inline">controller</code>
function:</p>
<pre><code class="nohighlight makeup elixir"><span class="kd">def</span><span class="w"> </span><span class="nf">controller</span><span class="w"> </span><span class="k" data-group-id="0637977842-1">do</span><span class="w">
</span><span class="k">quote</span><span class="w"> </span><span class="k" data-group-id="0637977842-2">do</span><span class="w">
<pre><code class="nohighlight makeup elixir"><span class="kd">def</span><span class="w"> </span><span class="nf">controller</span><span class="w"> </span><span class="k" data-group-id="6877224210-1">do</span><span class="w">
</span><span class="k">quote</span><span class="w"> </span><span class="k" data-group-id="6877224210-2">do</span><span class="w">
</span><span class="kn">use</span><span class="w"> </span><span class="nc">Phoenix.Controller</span><span class="w">
</span><span class="kn">use</span><span class="w"> </span><span class="nc">Thesis.Controller</span><span class="w">
</span><span class="c1"># ...</span><span class="w">
</span><span class="k" data-group-id="0637977842-2">end</span><span class="w">
</span><span class="k" data-group-id="0637977842-1">end</span></code></pre>
</span><span class="k" data-group-id="6877224210-2">end</span><span class="w">
</span><span class="k" data-group-id="6877224210-1">end</span></code></pre>
<p>If you&#39;d prefer to only use Thesis in certain controllers, remove it from
<code class="inline">web/web.ex</code> and add it to the specific controllers by doing this:</p>
<pre><code class="nohighlight makeup elixir"><span class="kd">defmodule</span><span class="w"> </span><span class="nc">MyApp.MyController</span><span class="w"> </span><span class="k" data-group-id="3353822046-1">do</span><span class="w">
<pre><code class="nohighlight makeup elixir"><span class="kd">defmodule</span><span class="w"> </span><span class="nc">MyApp.MyController</span><span class="w"> </span><span class="k" data-group-id="8288827529-1">do</span><span class="w">
</span><span class="kn">use</span><span class="w"> </span><span class="nc">Thesis.Controller</span><span class="w">
</span><span class="c1"># ...</span></code></pre>
</section>
Expand Down
5 changes: 3 additions & 2 deletions doc/Thesis.EctoStore.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
<meta name="generator" content="ExDoc v0.19.2">
<title>Thesis.EctoStore — thesis v0.3.2</title>
<link rel="stylesheet" href="dist/html-c1666276880c0f8e3769.css" />
<link rel="canonical" href="https://hexdocs.pm/thesis/Thesis.EctoStore.html" />
<script src="dist/sidebar_items-faefb02862.js"></script>

</head>
Expand Down Expand Up @@ -170,7 +171,7 @@ <h1 class="signature">backups(page_slug)</span>
</div>
<section class="docstring">
<p>Retrieves all backups for a given slug. Returns the backup.</p>
<pre><code class="nohighlight makeup elixir"><span class="n">backups</span><span class="p" data-group-id="0471619126-1">(</span><span class="n">slug</span><span class="p" data-group-id="0471619126-1">)</span></code></pre>
<pre><code class="nohighlight makeup elixir"><span class="n">backups</span><span class="p" data-group-id="4028305314-1">(</span><span class="n">slug</span><span class="p" data-group-id="4028305314-1">)</span></code></pre>
<p>Callback implementation for <a href="Thesis.Store.html#c:backups/1"><code class="inline">Thesis.Store.backups/1</code></a>.</p>
</section>
</section>
Expand Down Expand Up @@ -260,7 +261,7 @@ <h1 class="signature">restore(id)</span>
</div>
<section class="docstring">
<p>Retrieves a given backup (identified by its id). Returns the backup.</p>
<pre><code class="nohighlight makeup elixir"><span class="n">restore</span><span class="p" data-group-id="1782321323-1">(</span><span class="n">backup_id</span><span class="p" data-group-id="1782321323-1">)</span></code></pre>
<pre><code class="nohighlight makeup elixir"><span class="n">restore</span><span class="p" data-group-id="7191294602-1">(</span><span class="n">backup_id</span><span class="p" data-group-id="7191294602-1">)</span></code></pre>
<p>Callback implementation for <a href="Thesis.Store.html#c:restore/1"><code class="inline">Thesis.Store.restore/1</code></a>.</p>
</section>
</section>
Expand Down
1 change: 1 addition & 0 deletions doc/Thesis.File.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
<meta name="generator" content="ExDoc v0.19.2">
<title>Thesis.File — thesis v0.3.2</title>
<link rel="stylesheet" href="dist/html-c1666276880c0f8e3769.css" />
<link rel="canonical" href="https://hexdocs.pm/thesis/Thesis.File.html" />
<script src="dist/sidebar_items-faefb02862.js"></script>

</head>
Expand Down

0 comments on commit edb7ccf

Please sign in to comment.