Skip to content

Commit

Permalink
Deploy MkDocs site to GitHub Pages
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Aug 3, 2024
0 parents commit 82a9d1a
Show file tree
Hide file tree
Showing 76 changed files with 15,686 additions and 0 deletions.
122 changes: 122 additions & 0 deletions 404.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="shortcut icon" href="/img/favicon.ico" />
<title>SOAD Documentation</title>
<link rel="stylesheet" href="/css/theme.css" />
<link rel="stylesheet" href="/css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
<link href="/css/custom.css" rel="stylesheet" />

<!--[if lt IE 9]>
<script src="/js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
</head>

<body class="wy-body-for-nav" role="document">

<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="/." class="icon icon-home"> SOAD Documentation
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="//search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
</form>
</div>
</div>

<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="/.">Home</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="/installation/">Installation</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="/usage/">Usage</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="/deploying-infrastructure/">Deploying Infrastructure</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="/contributing/">Contributing</a>
</li>
</ul>
</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="/.">SOAD Documentation</a>

</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="/." class="icon icon-home" aria-label="Docs"></a></li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">


<h1 id="404-page-not-found">404</h1>

<p><strong>Page not found</strong></p>


</div>
</div><footer>

<hr/>

<div role="contentinfo">
<!-- Copyright etc -->
</div>

Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>

</div>
</div>

</section>

</div>

<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">



</span>
</div>
<script src="/js/jquery-3.6.0.min.js"></script>
<script>var base_url = "/";</script>
<script src="/js/theme_extra.js"></script>
<script src="/js/theme.js"></script>
<script src="/search/main.js"></script>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
174 changes: 174 additions & 0 deletions contributing/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,174 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Contributing - SOAD Documentation</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
<link href="../css/custom.css" rel="stylesheet" />

<script>
// Current page data
var mkdocs_page_name = "Contributing";
var mkdocs_page_input_path = "contributing.md";
var mkdocs_page_url = null;
</script>

<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
</head>

<body class="wy-body-for-nav" role="document">

<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> SOAD Documentation
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
</form>
</div>
</div>

<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../installation/">Installation</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../usage/">Usage</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../deploying-infrastructure/">Deploying Infrastructure</a>
</li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="#">Contributing</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#how-to-contribute">How to Contribute</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#code-of-conduct">Code of Conduct</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">SOAD Documentation</a>

</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" aria-label="Docs"></a></li>
<li class="breadcrumb-item active">Contributing</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">

<h1 id="contributing">Contributing</h1>
<p>We welcome contributions to the SOAD project. Here are some ways you can help:</p>
<ul>
<li>Report bugs</li>
<li>Fix issues</li>
<li>Add new features</li>
<li>Improve documentation</li>
</ul>
<h2 id="how-to-contribute">How to Contribute</h2>
<ol>
<li>
<p>Setup a python virtual environment</p>
<p><code>python -m pyenv python3.12</code></p>
</li>
<li>
<p>Install the required packages:</p>
<p><code>pip install -r requirements.txt</code></p>
</li>
<li>
<p>Initialize the database with fake data:</p>
<p><code>python init_db.py</code></p>
</li>
<li>
<p>Start the frontend (React) server</p>
<p>NOTE: right now you will have to edit this line in <code>src/axiosInstance.js</code> file locally to point to <code>http://localhost:8000</code>:
https://github.com/r0fls/soad/blob/main/trading-dashboard/src/axiosInstance.js#L4</p>
<p>Then:</p>
<p><code>cd trading-dashboard
yarn start</code></p>
</li>
<li>
<p>Start the python API (in a second terminal window)</p>
<p><code>python main.py --mode api</code></p>
</li>
</ol>
<h2 id="code-of-conduct">Code of Conduct</h2>
<p>If you have any problems getting, feel free to create a Github issue.</p>
<p>Please follow our <a href="https://github.com/r0fls/soad/blob/main/CODE_OF_CONDUCT.md">Code of Conduct</a>.</p>

</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../deploying-infrastructure/" class="btn btn-neutral float-left" title="Deploying Infrastructure"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div>

<hr/>

<div role="contentinfo">
<!-- Copyright etc -->
</div>

Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>

</div>
</div>

</section>

</div>

<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">


<span><a href="../deploying-infrastructure/" style="color: #fcfcfc">&laquo; Previous</a></span>


</span>
</div>
<script src="../js/jquery-3.6.0.min.js"></script>
<script>var base_url = "..";</script>
<script src="../js/theme_extra.js"></script>
<script src="../js/theme.js"></script>
<script src="../search/main.js"></script>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
16 changes: 16 additions & 0 deletions css/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
.wy-side-nav-search {
position: relative;
}

.wy-nav-side::after {
content: "";
background: url("https://github.com/r0fls/soad/assets/1858004/1ac6d1c7-5263-4b8a-a643-148ee54c12c1") no-repeat;
background-size: contain;
position: absolute;
bottom: 20px; /* Adjust the distance from the bottom as needed */
left: 50%;
transform: translateX(-50%);
width: 100px; /* Adjust the width as needed */
height: 100px; /* Adjust the height as needed */
z-index: 1000; /* Ensure it appears above other elements */
}
Binary file added css/fonts/Roboto-Slab-Bold.woff
Binary file not shown.
Binary file added css/fonts/Roboto-Slab-Bold.woff2
Binary file not shown.
Binary file added css/fonts/Roboto-Slab-Regular.woff
Binary file not shown.
Binary file added css/fonts/Roboto-Slab-Regular.woff2
Binary file not shown.
Binary file added css/fonts/fontawesome-webfont.eot
Binary file not shown.
Loading

0 comments on commit 82a9d1a

Please sign in to comment.