Skip to content

Commit

Permalink
fix logo/sim in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@rohanchandra30
rohanchandra30 committed Feb 22, 2024
1 parent de4e13d commit dfdd71a
Show file tree
Hide file tree
Showing 316 changed files with 5,469 additions and 17,301 deletions.
31 changes: 14 additions & 17 deletions docs/_site/contributing/making_docs.html
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Making docs &mdash; Social Gym 2.0 documentation</title>
Expand All @@ -13,8 +13,9 @@
<![endif]-->

<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/sphinx_highlight.js"></script>
<script src="../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
Expand All @@ -25,16 +26,12 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >



<a href="../../index.html" class="icon icon-home">
Social Gym 2.0
<img src="https://drive.google.com/uc?id=1y3vYhN6z55B0k7SRHf7gycan3rzWSsj8" class="logo" alt="Logo"/>
<a href="../../index.html" class="icon icon-home"> Social Gym 2.0
<img src="https://raw.githubusercontent.com/ut-amrl/SocialGym2/main/assets/sg2_logo.png" class="logo" alt="Logo"/>
</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" />
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
Expand Down Expand Up @@ -62,7 +59,7 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li><a href="../../index.html" class="icon icon-home"></a></li>
<li class="breadcrumb-item active">Making docs</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/_site/contributing/making_docs.md.txt" rel="nofollow"> View page source</a>
Expand All @@ -74,7 +71,7 @@
<div itemprop="articleBody">

<section id="making-docs">
<h1>Making docs<a class="headerlink" href="#making-docs" title="Permalink to this heading"></a></h1>
<h1>Making docs<a class="headerlink" href="#making-docs" title="Permalink to this headline"></a></h1>
<p>The source code for all the documentation can be found in <code class="docutils literal notranslate"><span class="pre">{PROJECT_ROOT}/docs_src</span></code></p>
<p>We use <a class="reference external" href="https://www.sphinx-doc.org/en/master/">Sphinx</a> to create our documentation and host it in Github Pages.</p>
<p>Check out <code class="docutils literal notranslate"><span class="pre">docs_src/index.rst</span></code> for the layout of the pages (starting on line 6). That file will point to the source doc
Expand All @@ -86,17 +83,17 @@ <h1>Making docs<a class="headerlink" href="#making-docs" title="Permalink to thi
as you save files.) The service is usually hosted on http://127.0.0.1:8000 but it will also tell you where the local
version of the site is.</p>
<section id="uploading-changes">
<h2>Uploading changes<a class="headerlink" href="#uploading-changes" title="Permalink to this heading"></a></h2>
<h2>Uploading changes<a class="headerlink" href="#uploading-changes" title="Permalink to this headline"></a></h2>
<section id="run-build-sh">
<h3>1.) Run <code class="docutils literal notranslate"><span class="pre">./build.sh</span></code><a class="headerlink" href="#run-build-sh" title="Permalink to this heading"></a></h3>
<h3>1.) Run <code class="docutils literal notranslate"><span class="pre">./build.sh</span></code><a class="headerlink" href="#run-build-sh" title="Permalink to this headline"></a></h3>
</section>
<section id="run-git-add-sh">
<h3>2.) Run <code class="docutils literal notranslate"><span class="pre">./git_add.sh</span></code><a class="headerlink" href="#run-git-add-sh" title="Permalink to this heading"></a></h3>
<h3>2.) Run <code class="docutils literal notranslate"><span class="pre">./git_add.sh</span></code><a class="headerlink" href="#run-git-add-sh" title="Permalink to this headline"></a></h3>
</section>
<section id="the-files-are-now-staged-in-git-you-can-do">
<h3>3.) The files are now staged in git, you can do<a class="headerlink" href="#the-files-are-now-staged-in-git-you-can-do" title="Permalink to this heading"></a></h3>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>commit<span class="w"> </span>-m<span class="w"> </span><span class="s2">&quot;Doc changes&quot;</span>
git<span class="w"> </span>push
<h3>3.) The files are now staged in git, you can do<a class="headerlink" href="#the-files-are-now-staged-in-git-you-can-do" title="Permalink to this headline"></a></h3>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>git commit -m <span class="s2">&quot;Doc changes&quot;</span>
git push
</pre></div>
</div>
<p>and the website should update within the next 5-10minutes.</p>
Expand Down
21 changes: 9 additions & 12 deletions docs/_site/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Welcome to the Social Gym 2.0 documentation! &mdash; Social Gym 2.0 documentation</title>
Expand All @@ -13,8 +13,9 @@
<![endif]-->

<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
Expand All @@ -25,16 +26,12 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >



<a href="../index.html" class="icon icon-home">
Social Gym 2.0
<img src="https://drive.google.com/uc?id=1y3vYhN6z55B0k7SRHf7gycan3rzWSsj8" class="logo" alt="Logo"/>
<a href="../index.html" class="icon icon-home"> Social Gym 2.0
<img src="https://raw.githubusercontent.com/ut-amrl/SocialGym2/main/assets/sg2_logo.png" class="logo" alt="Logo"/>
</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" />
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
Expand Down Expand Up @@ -62,7 +59,7 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li><a href="../index.html" class="icon icon-home"></a></li>
<li class="breadcrumb-item active">Welcome to the Social Gym 2.0 documentation!</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/_site/index.rst.txt" rel="nofollow"> View page source</a>
Expand All @@ -74,7 +71,7 @@
<div itemprop="articleBody">

<section id="welcome-to-the-social-gym-2-0-documentation">
<h1>Welcome to the Social Gym 2.0 documentation!<a class="headerlink" href="#welcome-to-the-social-gym-2-0-documentation" title="Permalink to this heading"></a></h1>
<h1>Welcome to the Social Gym 2.0 documentation!<a class="headerlink" href="#welcome-to-the-social-gym-2-0-documentation" title="Permalink to this headline"></a></h1>
<p>(Find the GitHub link at <a class="reference external" href="https://github.com/ut-amrl/social_gym">https://github.com/ut-amrl/social_gym</a>)</p>
<a class="reference internal image-reference" href="https://obj.umiacs.umd.edu/badue-accepted/sim_demo.gif"><img alt="https://obj.umiacs.umd.edu/badue-accepted/sim_demo.gif" class="align-center" src="https://obj.umiacs.umd.edu/badue-accepted/sim_demo.gif" style="width: 400px;" /></a>
<div class="line-block">
Expand Down Expand Up @@ -116,7 +113,7 @@ <h1>Welcome to the Social Gym 2.0 documentation!<a class="headerlink" href="#wel
</div>
</section>
<section id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this heading"></a></h1>
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h1>
<ul class="simple">
<li><p><a class="reference internal" href="../genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="../py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
Expand Down
Loading

0 comments on commit dfdd71a

Please sign in to comment.