Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@ardunn
ardunn committed Aug 8, 2019
1 parent d455225 commit ab27c8b
Show file tree
Hide file tree
Showing 13 changed files with 42 additions and 8 deletions.
1 change: 1 addition & 0 deletions docs/_sources/index.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ User manual
basic.rst
advanced.rst
datasets.rst
tutorials.rst
license.rst


Expand Down
10 changes: 5 additions & 5 deletions docs/_static/alabaster.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ div.sphinxsidebar h3.donation {
/* -- body styles ----------------------------------------------------------- */

a {
color: #aa560c;
color: #0c7baa;
text-decoration: underline;
}

Expand Down Expand Up @@ -327,8 +327,8 @@ p.admonition-title:after {
}

pre, tt, code {
font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
font-size: 0.9em;
font-family: Ubuntu Mono;
font-size: 16;
}

.hll {
Expand Down Expand Up @@ -467,7 +467,7 @@ tt.xref, code.xref, a tt {

a.reference {
text-decoration: none;
border-bottom: 1px dotted #aa560c;
border-bottom: 1px dotted #0c7baa;
}

/* Don't put an underline on images */
Expand All @@ -483,7 +483,7 @@ a.footnote-reference {
text-decoration: none;
font-size: 0.7em;
vertical-align: top;
border-bottom: 1px dotted #aa560c;
border-bottom: 1px dotted #0c7baa;
}

a.footnote-reference:hover {
Expand Down
2 changes: 2 additions & 0 deletions docs/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
<link rel="index" title="Index" href="#" />
<link rel="search" title="Search" href="search.html" />
<link href="https://fonts.googleapis.com/css?family=Nunito&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css?family=Ubuntu+Mono&display=swap" rel="stylesheet">

</head><body>
<div class="document">
Expand All @@ -40,6 +41,7 @@ <h3>Navigation</h3>
<li class="toctree-l1"><a class="reference internal" href="basic.html">Basic Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="advanced.html">Advanced Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="datasets.html">MatBench benchmark</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
</ul>
<ul>
Expand Down
7 changes: 7 additions & 0 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Installation" href="installation.html" />
<link href="https://fonts.googleapis.com/css?family=Nunito&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css?family=Ubuntu+Mono&display=swap" rel="stylesheet">

</head><body>
<div class="document">
Expand All @@ -40,6 +41,7 @@ <h3>Navigation</h3>
<li class="toctree-l1"><a class="reference internal" href="basic.html">Basic Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="advanced.html">Advanced Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="datasets.html">MatBench benchmark</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
</ul>
<ul>
Expand Down Expand Up @@ -131,6 +133,11 @@ <h1>User manual<a class="headerlink" href="#user-manual" title="Permalink to thi
<li class="toctree-l2"><a class="reference internal" href="datasets.html#some-heading-2">Some heading 2</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorials.html#tutorial-1">Tutorial 1:</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials.html#tutorial-2">Tutorial 2:</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
</ul>
</div>
Expand Down
2 changes: 2 additions & 0 deletions docs/installation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
<link rel="next" title="Basic Usage" href="basic.html" />
<link rel="prev" title="How it works" href="index.html" />
<link href="https://fonts.googleapis.com/css?family=Nunito&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css?family=Ubuntu+Mono&display=swap" rel="stylesheet">

</head><body>
<div class="document">
Expand Down Expand Up @@ -45,6 +46,7 @@ <h3>Navigation</h3>
<li class="toctree-l1"><a class="reference internal" href="basic.html">Basic Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="advanced.html">Advanced Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="datasets.html">MatBench benchmark</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
</ul>
<ul>
Expand Down
4 changes: 3 additions & 1 deletion docs/license.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,9 @@
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="docs" href="modules.html" />
<link rel="prev" title="MatBench benchmark" href="datasets.html" />
<link rel="prev" title="Tutorials" href="tutorials.html" />
<link href="https://fonts.googleapis.com/css?family=Nunito&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css?family=Ubuntu+Mono&display=swap" rel="stylesheet">

</head><body>
<div class="document">
Expand All @@ -41,6 +42,7 @@ <h3>Navigation</h3>
<li class="toctree-l1"><a class="reference internal" href="basic.html">Basic Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="advanced.html">Advanced Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="datasets.html">MatBench benchmark</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">License</a></li>
</ul>
<ul>
Expand Down
Binary file modified docs/objects.inv
View file
Binary file not shown.
2 changes: 2 additions & 0 deletions docs/search.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
<script type="text/javascript" src="searchindex.js" defer></script>

<link href="https://fonts.googleapis.com/css?family=Nunito&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css?family=Ubuntu+Mono&display=swap" rel="stylesheet">


</head><body>
Expand All @@ -44,6 +45,7 @@ <h3>Navigation</h3>
<li class="toctree-l1"><a class="reference internal" href="basic.html">Basic Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="advanced.html">Advanced Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="datasets.html">MatBench benchmark</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
</ul>
<ul>
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions docs/source/_templates/layout.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

{% block extrahead %}
<link href="https://fonts.googleapis.com/css?family=Nunito&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css?family=Ubuntu+Mono&display=swap" rel="stylesheet">
{% endblock %}

{%- block sidebarsourcelink %}
Expand Down
4 changes: 3 additions & 1 deletion docs/source/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@
# 'logo': 'logo_lowres.png',
'github_repo': 'hackingmaterials/automatminer',
'github_button': 'true',
'link': '#aa560c',
'link': '#0c7baa',
'show_powered_by': 'false',
'fixed_sidebar': 'true',
'font_family': 'Nunito',
Expand All @@ -161,6 +161,8 @@
'description_font_style': 'Nunito',
'description': "An autoML tool for materials",
'font_size': 12,
'code_font_family': 'Ubuntu Mono',
'code_font_size': 16,

# 'page_width': 300,
# 'sidebar_width': 150,
Expand Down
1 change: 1 addition & 0 deletions docs/source/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ User manual
basic.rst
advanced.rst
datasets.rst
tutorials.rst
license.rst


Expand Down
14 changes: 14 additions & 0 deletions docs/source/tutorials.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Tutorials
=========




Tutorial 1:
-----------


Tutorial 2:
-----------


0 comments on commit ab27c8b

Please sign in to comment.