This repository has been archived by the owner on Jan 23, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feature: add readthedocs integration
- Loading branch information
Showing
16 changed files
with
238 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| version: 2 | ||
| sphinx: | ||
| configuration: doc/source/conf.py | ||
| python: | ||
| version: 3.7 | ||
| install: | ||
| - requirements: doc/requirements.txt |
Binary file not shown.
Binary file not shown.
Binary file not shown.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,148 @@ | ||
|
|
||
| <!DOCTYPE html> | ||
|
|
||
| <html xmlns="http://www.w3.org/1999/xhtml"> | ||
| <head> | ||
| <meta charset="utf-8" /> | ||
| <title>Welcome to The Sheriff’s documentation! — The Sheriff 1.0.0 documentation</title> | ||
| <link rel="stylesheet" href="_static/alabaster.css" type="text/css" /> | ||
| <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> | ||
| <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> | ||
| <script type="text/javascript" src="_static/jquery.js"></script> | ||
| <script type="text/javascript" src="_static/underscore.js"></script> | ||
| <script type="text/javascript" src="_static/doctools.js"></script> | ||
| <script type="text/javascript" src="_static/language_data.js"></script> | ||
| <link rel="index" title="Index" href="genindex.html" /> | ||
| <link rel="search" title="Search" href="search.html" /> | ||
| <link rel="next" title="The Sheriff Usage" href="usage.html" /> | ||
|
|
||
| <link rel="stylesheet" href="_static/custom.css" type="text/css" /> | ||
|
|
||
|
|
||
| <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> | ||
|
|
||
| </head><body> | ||
|
|
||
|
|
||
| <div class="document"> | ||
| <div class="documentwrapper"> | ||
| <div class="bodywrapper"> | ||
|
|
||
|
|
||
| <div class="body" role="main"> | ||
|
|
||
| <div class="section" id="welcome-to-the-sheriff-s-documentation"> | ||
| <h1>Welcome to The Sheriff’s documentation!<a class="headerlink" href="#welcome-to-the-sheriff-s-documentation" title="Permalink to this headline">¶</a></h1> | ||
| <div class="toctree-wrapper compound"> | ||
| </div> | ||
| <div class="section" id="application-usage"> | ||
| <h2>Application usage<a class="headerlink" href="#application-usage" title="Permalink to this headline">¶</a></h2> | ||
| <p>Here’s all you need to run and test The Sheriff application.</p> | ||
| <div class="toctree-wrapper compound"> | ||
| <ul> | ||
| <li class="toctree-l1"><a class="reference internal" href="usage.html">The Sheriff Usage</a><ul> | ||
| <li class="toctree-l2"><a class="reference internal" href="usage.html#runtime-requirements">Runtime Requirements</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="usage.html#validating-use-cases">Validating use cases</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="usage.html#development-requirements">Development Requirements</a></li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| </div> | ||
| </div> | ||
| <div class="section" id="the-api-documentation"> | ||
| <h2>The API Documentation<a class="headerlink" href="#the-api-documentation" title="Permalink to this headline">¶</a></h2> | ||
| <p>If you are looking for information on a specific function, class, or method, | ||
| this part of the documentation is for you.</p> | ||
| <div class="toctree-wrapper compound"> | ||
| <ul> | ||
| <li class="toctree-l1"><a class="reference internal" href="infrastructure.html">The Sheriff Infrastructure</a><ul> | ||
| <li class="toctree-l2"><a class="reference internal" href="infrastructure.html#controllers">Controllers</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="infrastructure.html#repositories">Repositories</a></li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| </div> | ||
| </div> | ||
| </div> | ||
|
|
||
|
|
||
| </div> | ||
|
|
||
| </div> | ||
| </div> | ||
| <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | ||
| <div class="sphinxsidebarwrapper"> | ||
| <p class="logo"><a href="#"> | ||
| <img class="logo" src="_static/logo.png" alt="Logo"/> | ||
| </a></p> | ||
| <h1 class="logo"><a href="#">The Sheriff</a></h1> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <h3>Navigation</h3> | ||
| <ul> | ||
| <li class="toctree-l1"><a class="reference internal" href="usage.html">The Sheriff Usage</a></li> | ||
| </ul> | ||
| <ul> | ||
| <li class="toctree-l1"><a class="reference internal" href="infrastructure.html">The Sheriff Infrastructure</a></li> | ||
| </ul> | ||
|
|
||
|
|
||
| <hr /> | ||
| <ul> | ||
|
|
||
| <li class="toctree-l1"><a href="https://github.com/tripledes/thesheriff">🚀 Github</a></li> | ||
|
|
||
| </ul> | ||
| <div class="relations"> | ||
| <h3>Related Topics</h3> | ||
| <ul> | ||
| <li><a href="#">Documentation overview</a><ul> | ||
| <li>Next: <a href="usage.html" title="next chapter">The Sheriff Usage</a></li> | ||
| </ul></li> | ||
| </ul> | ||
| </div> | ||
| <div id="searchbox" style="display: none" role="search"> | ||
| <h3 id="searchlabel">Quick search</h3> | ||
| <div class="searchformwrapper"> | ||
| <form class="search" action="search.html" method="get"> | ||
| <input type="text" name="q" aria-labelledby="searchlabel" /> | ||
| <input type="submit" value="Go" /> | ||
| </form> | ||
| </div> | ||
| </div> | ||
| <script type="text/javascript">$('#searchbox').show(0);</script> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| </div> | ||
| </div> | ||
| <div class="clearer"></div> | ||
| </div> | ||
| <div class="footer"> | ||
| ©2019, The Sheriff Team. | ||
|
|
||
| | | ||
| Powered by <a href="http://sphinx-doc.org/">Sphinx 2.2.0</a> | ||
| & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> | ||
|
|
||
| | | ||
| <a href="_sources/contents.rst.txt" | ||
| rel="nofollow">Page source</a> | ||
| </div> | ||
|
|
||
|
|
||
|
|
||
|
|
||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.