make docs prettier

esonderegger · Jun 27, 2018 · 975af1c · 975af1c
1 parent da43205
commit 975af1c
Show file tree

Hide file tree

Showing 8 changed files with 40 additions and 14 deletions.
diff --git a/.gitignore b/.gitignore
@@ -105,3 +105,7 @@ venv.bak/
 
 # OSX
 .DS_Store
+
+# Github pages
+docs/_site
+docs/Gemfile*
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
@@ -3,7 +3,10 @@
   <head>
     <meta charset="UTF-8">
     <title>{{ page.title }}</title>
-    <link href="/css/fecfile.css" rel="stylesheet">
+    <link href="css/fecfile.css" rel="stylesheet">
+    <link rel="apple-touch-icon" sizes="180x180" href="apple-touch-icon.png">
+    <link rel="icon" type="image/png" sizes="32x32" href="favicon-32x32.png">
+    <link rel="icon" type="image/png" sizes="16x16" href="favicon-16x16.png">
   </head>
   <body>{{ content }}</body>
 </html>
diff --git a/docs/apple-touch-icon.png b/docs/apple-touch-icon.png
diff --git a/docs/css/fecfile.css b/docs/css/fecfile.css
@@ -2,17 +2,34 @@ body {
   font-size: 18px;
   font-family: "HelveticaNeue-Light", "Helvetica Neue Light", "Helvetica Neue", Helvetica, Arial, "Lucida Grande", sans-serif;
   font-weight: 300;
-  margin: 2em auto;
-  max-width: 36em;
+  margin: 1em 2em;
   line-height: 1.5;
   color: #444;
-  padding: 0 0.5em;
 }
 h1, h2, h3 {
   line-height: 1.2;
+  max-width: 40rem;
+  margin: .5em auto;
+}
+p, ul {
+  max-width: 40rem;
+  margin: 1em auto;
+}
+a {
+  color: #268bd2;
+}
+
+pre {
+  background-color: #002b36;
+  border-radius: .75em;
+  color: #93a1a1;
+  font-size: .9em;
+  max-width: 42em;
+  overflow-x: auto;
+  margin: 1em auto;
+  padding: 1em;
 }
 
-.highlight { background-color: #002b36; color: #93a1a1; }
 .highlight .c { color: #759299; }
 .highlight .err { color: #93a1a1; }
 .highlight .g { color: #93a1a1; }

diff --git a/docs/favicon-16x16.png b/docs/favicon-16x16.png
diff --git a/docs/favicon-32x32.png b/docs/favicon-32x32.png
diff --git a/docs/favicon.ico b/docs/favicon.ico
diff --git a/docs/index.md b/docs/index.md
@@ -1,6 +1,6 @@
 ---
 layout: default
-title: fecfile: a python parser for the .fec file format
+title: fecfile&#58; a python parser for the .fec file format
 ---
 
 # fecfile
@@ -13,10 +13,12 @@ The goal of this project is to parse data in the .fec format and return a native
 ## Installation
 To get started, install from [pypi](https://pypi.org/project/fecfile/) by running the following command in your preferred terminal:
 
-    pip install fecfile
+```shell
+pip install fecfile
+```
 
 ## Usage (the hard way)
-```
+```python
 import fecfile
 import json
 
@@ -27,7 +29,7 @@ with open('1229017.fec') as file:
 
 or:
 
-```
+```python
 import fecfile
 import json
 import requests
@@ -42,7 +44,7 @@ Note: the docquery.fec.gov urls cause problems with the requests library when a
 
 ## Usage (the easy way)
 
-```
+```python
 import fecfile
 import json
 
@@ -58,27 +60,27 @@ Note the `default=str` parameter - that allows serializing to json dictionaries
 
 Assuming you already have Python3 and the ability to create virtual environments installed, first clone this repository from github and cd into it:
 
-```
+```shell
 git clone https://github.com/esonderegger/fecfile.git
 cd fecfile
 ```
 
 Then create a virtual environment for this project (I use the following commands, but there are several ways to get the desired result):
 
-```
+```shell
 python3 -m venv ~/.virtualenvs/fecfile
 source ~/.virtualenvs/fecfile/bin/activate
 ```
 
 Next, install the dependencies:
 
-```
+```shell
 python setup.py
 ```
 
 Finally, make some changes, and run:
 
-```
+```shell
 python tests.py
 ```