Merge pull request #85 from gnosis/fix-doc-gen

More template tweaks
gnosis · Feb 8, 2018 · 89b2af2 · 89b2af2
2 parents 2492e9f + a265aa5
commit 89b2af2
Show file tree

Hide file tree

Showing 35 changed files with 73 additions and 1 deletion.
diff --git a/_config.yml b/_config.yml
@@ -1 +1,2 @@
 theme: jekyll-theme-dinky
+permalink: pretty
diff --git a/_layout/default.html b/_layout/default.html
@@ -0,0 +1,70 @@
+<!doctype html>
+<html lang="{{ site.lang | default: "en-US" }}">
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="chrome=1">
+
+{% seo %}
+    <link href='https://fonts.googleapis.com/css?family=Arvo:400,700,400italic' rel='stylesheet' type='text/css'>
+    <link rel="stylesheet" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}">
+    <script src="{{ '/assets/js/scale.fix.js' | relative_url }}"></script>
+    <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
+    <!--[if lt IE 9]>
+    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+  </head>
+  <body>
+    <div class="wrapper">
+      <header>
+        <h1 class="header">{{ site.title | default: site.github.repository_name }}</h1>
+        <p class="header">{{ site.description | default: site.github.project_tagline }}</p>
+
+        <ul>
+          {% if site.show_downloads %}
+            <li class="download"><a class="buttons" href="{{ site.github.zip_url }}">Download ZIP</a></li>
+            <li class="download"><a class="buttons" href="{{ site.github.tar_url }}">Download TAR</a></li>
+          {% endif %}
+          <li><a class="buttons github" href="{{ site.github.repository_url }}">View On GitHub</a></li>
+          <li>
+            <label for="contracts">Contracts</label>
+            <select id="contracts" name="contracts">
+              <option value="" selected>Please choose</option>
+              {% for page in site.pages %}
+                <option value="{{ page.url }}">{{ page.title }} | {{ page.url }}</option>
+              {% endfor %}
+            </select>
+          </li>
+        </ul>
+
+        {% if site.github.is_project_page %}
+          <p class="header">This project is maintained by <a class="header name" href="{{ site.github.owner_url }}">{{ site.github.owner_name }}</a></p>
+        {% endif %}
+
+        {% if site.github.is_user_page %}
+          <ul>
+            <li><a class="buttons github" href="{{ site.github.owner_url }}">GitHub Profile</a></li>
+          </ul>
+        {% endif %}
+      </header>
+
+      <section>
+        {{ content }}
+      </section>
+
+      <footer>
+        <p><small>Hosted on <a href="https://pages.github.com">GitHub Pages</a> using the Dinky theme</small></p>
+      </footer>
+    </div>
+    <!--[if !IE]><script>fixScale(document);</script><![endif]-->
+    {% if site.google_analytics %}
+      <script type="text/javascript">
+        (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+        (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+        m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+        })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+        ga('create', '{{ site.google_analytics }}', 'auto');
+        ga('send', 'pageview');
+      </script>
+    {% endif %}
+  </body>
+</html>
diff --git a/docs/Campaign/index.md → docs/Campaign.md b/docs/Campaign/index.md → docs/Campaign.md
diff --git a/docs/CampaignFactory/index.md → docs/CampaignFactory.md b/docs/CampaignFactory/index.md → docs/CampaignFactory.md
diff --git a/docs/CategoricalEvent/index.md → docs/CategoricalEvent.md b/docs/CategoricalEvent/index.md → docs/CategoricalEvent.md
diff --git a/docs/CentralizedOracle/index.md → docs/CentralizedOracle.md b/docs/CentralizedOracle/index.md → docs/CentralizedOracle.md
diff --git a/docs/CentralizedOracleFactory/index.md → docs/CentralizedOracleFactory.md b/docs/CentralizedOracleFactory/index.md → docs/CentralizedOracleFactory.md
diff --git a/docs/DifficultyOracle/index.md → docs/DifficultyOracle.md b/docs/DifficultyOracle/index.md → docs/DifficultyOracle.md
diff --git a/docs/DifficultyOracleFactory/index.md → docs/DifficultyOracleFactory.md b/docs/DifficultyOracleFactory/index.md → docs/DifficultyOracleFactory.md
diff --git a/docs/EtherToken/index.md → docs/EtherToken.md b/docs/EtherToken/index.md → docs/EtherToken.md
diff --git a/docs/Event/index.md → docs/Event.md b/docs/Event/index.md → docs/Event.md
diff --git a/docs/EventFactory/index.md → docs/EventFactory.md b/docs/EventFactory/index.md → docs/EventFactory.md
diff --git a/docs/FutarchyOracle/index.md → docs/FutarchyOracle.md b/docs/FutarchyOracle/index.md → docs/FutarchyOracle.md
diff --git a/docs/FutarchyOracleFactory/index.md → docs/FutarchyOracleFactory.md b/docs/FutarchyOracleFactory/index.md → docs/FutarchyOracleFactory.md
diff --git a/docs/HumanFriendlyToken/index.md → docs/HumanFriendlyToken.md b/docs/HumanFriendlyToken/index.md → docs/HumanFriendlyToken.md
diff --git a/docs/LMSRMarketMaker/index.md → docs/LMSRMarketMaker.md b/docs/LMSRMarketMaker/index.md → docs/LMSRMarketMaker.md
diff --git a/docs/MajorityOracle/index.md → docs/MajorityOracle.md b/docs/MajorityOracle/index.md → docs/MajorityOracle.md
diff --git a/docs/MajorityOracleFactory/index.md → docs/MajorityOracleFactory.md b/docs/MajorityOracleFactory/index.md → docs/MajorityOracleFactory.md
diff --git a/docs/Market/index.md → docs/Market.md b/docs/Market/index.md → docs/Market.md
diff --git a/docs/MarketMaker/index.md → docs/MarketMaker.md b/docs/MarketMaker/index.md → docs/MarketMaker.md
diff --git a/docs/Math/index.md → docs/Math.md b/docs/Math/index.md → docs/Math.md
diff --git a/docs/Oracle/index.md → docs/Oracle.md b/docs/Oracle/index.md → docs/Oracle.md
diff --git a/docs/OutcomeToken/index.md → docs/OutcomeToken.md b/docs/OutcomeToken/index.md → docs/OutcomeToken.md
diff --git a/docs/ScalarEvent/index.md → docs/ScalarEvent.md b/docs/ScalarEvent/index.md → docs/ScalarEvent.md
diff --git a/docs/SignedMessageOracle/index.md → docs/SignedMessageOracle.md b/docs/SignedMessageOracle/index.md → docs/SignedMessageOracle.md
diff --git a/docs/SignedMessageOracleFactory/index.md → docs/SignedMessageOracleFactory.md b/docs/SignedMessageOracleFactory/index.md → docs/SignedMessageOracleFactory.md
diff --git a/docs/StandardMarket/index.md → docs/StandardMarket.md b/docs/StandardMarket/index.md → docs/StandardMarket.md
diff --git a/docs/StandardMarketFactory/index.md → docs/StandardMarketFactory.md b/docs/StandardMarketFactory/index.md → docs/StandardMarketFactory.md
diff --git a/docs/StandardMarketWithPriceLogger/index.md → docs/StandardMarketWithPriceLogger.md b/docs/StandardMarketWithPriceLogger/index.md → docs/StandardMarketWithPriceLogger.md
diff --git a/...dardMarketWithPriceLoggerFactory/index.md → docs/StandardMarketWithPriceLoggerFactory.md b/...dardMarketWithPriceLoggerFactory/index.md → docs/StandardMarketWithPriceLoggerFactory.md
diff --git a/docs/StandardToken/index.md → docs/StandardToken.md b/docs/StandardToken/index.md → docs/StandardToken.md
diff --git a/docs/Token/index.md → docs/Token.md b/docs/Token/index.md → docs/Token.md
diff --git a/docs/UltimateOracle/index.md → docs/UltimateOracle.md b/docs/UltimateOracle/index.md → docs/UltimateOracle.md
diff --git a/docs/UltimateOracleFactory/index.md → docs/UltimateOracleFactory.md b/docs/UltimateOracleFactory/index.md → docs/UltimateOracleFactory.md
diff --git a/scripts/makedocs.sh b/scripts/makedocs.sh
@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
 
 rm -r docs
-find contracts -name '*.sol' ! -name 'Migrations.sol' -type f -exec bash -c 'mkdir -p docs/`basename {} .sol`; ./node_modules/.bin/solmd {} --dest docs/`basename {} .sol`/index.md' \;
+mkdir docs
+find contracts -name '*.sol' ! -name 'Migrations.sol' -type f -exec bash -c './node_modules/.bin/solmd {} --dest docs/`basename {} .sol`.md' \;