Update and package them

d0ugal · d0ugal · commit b377998b9c48 · 2015-06-27T21:25:36.000+01:00
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -0,0 +1,3 @@
+recursive-include basic_theme *.ico *.js *.css *.png *.html *.eot *.svg *.ttf *.woff
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
diff --git a/basic_theme/__init__.py b/basic_theme/__init__.py
diff --git a/basic_theme/base.html b/basic_theme/base.html
@@ -24,6 +24,14 @@
     <link rel="shortcut icon" href="{{ base_url }}/img/favicon.ico">
   {% endif %}
 
+  <!--
+    You can include external assets of course, but be aware that it means the
+    documentation may not work well offline.
+  -->
+  <link rel="stylesheet" href="http://yui.yahooapis.com/pure/0.6.0/pure-min.css">
+
+  <link rel="stylesheet" href="{{ base_url }}/css/theme.css">
+
   <!--
     extra_ess contains paths to CSS files in the users
     documentation directory or a list of CSS files defined in
@@ -78,29 +86,21 @@
 
   <h1>This is an example theme.</h1>
 
-  <h2>Generate Navigation</h2>
+  <h2>Documentation Navigation</h2>
+
   <!--
     Create the navigation for the documentation.
+
+    Because we don't know how many levels deep the navigation is, it needs to
+    be included in it's own file so it can be recursive. Otherwise the theme
+    can also only support a specific number of levels.
+
+    See the nav.html file for more details about how this works.
   -->
   <ul>
-      {% for nav_item in nav %}
-          {% if nav_item.children %}
-              <li>{{ nav_item.title }}
-                  <ul>
-                  {% for nav_item in nav_item.children %}
-                      <li class="{% if nav_item.active%}current{%endif%}">
-                          <a href="{{ nav_item.url }}">{{ nav_item.title }}</a>
-                      </li>
-                  {% endfor %}
-                  </ul>
-              </li>
-          {% else %}
-              <li class="{% if nav_item.active%}current{%endif%}">
-                  <a href="{{ nav_item.url }}">{{ nav_item.title }}</a>
-              </li>
-          {% endif %}
-
-      {% endfor %}
+  {% for nav_item in nav %}
+    {% include "nav.html" %}
+  {% endfor %}
   </ul>
 
   <hr/>
@@ -126,11 +126,16 @@ <h2>Next and previous links</h2>
   -->
   {% if next_page or previous_page %}
     <div>
-      {% if next_page %}
-        <a href="{{ next_page.url }}" title="{{ next_page.title }}"/>Next Page</a>
-      {% endif %}
       {% if previous_page %}
-        <a href="{{ previous_page.url }}" title="{{ previous_page.title }}">Previous Page</a>
+        <a href="{{ previous_page.url }}" title="{{ previous_page.title }}">&#8592; Previous Page</a>
+      {% else %}
+        &#8592; Previous Page
+      {% endif %}
+      -
+      {% if next_page %}
+        <a href="{{ next_page.url }}" title="{{ next_page.title }}"/>Next Page &#8594;</a>
+      {% else %}
+        Next Page &#8594;
       {% endif %}
     </div>
   {% endif %}
@@ -171,7 +176,7 @@ <h2>Show the table of contents for the current page</h2>
 
   <hr/>
 
-  Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+  Built with <a href="http://www.mkdocs.org">MkDocs</a>.
 
   <!--
   MkDocs version      : {{ mkdocs_version }}
diff --git a/basic_theme/css/theme.css b/basic_theme/css/theme.css
@@ -0,0 +1,4 @@
+.active a {
+    color: red;
+    font-weight: bold;
+}
diff --git a/basic_theme/js/theme.js b/basic_theme/js/theme.js
@@ -0,0 +1,4 @@
+/*
+ * This JavaScript doesn't do anything. The file exists just to demonstrate
+ * including static assets from the HTML in themes.
+ */
diff --git a/basic_theme/nav.html b/basic_theme/nav.html
@@ -0,0 +1,17 @@
+<!--
+
+-->
+{% if not nav_item.children %}
+<li {% if nav_item.active %}class="active"{% endif %}>
+    <a href="{{ nav_item.url }}">{{ nav_item.title }}</a>
+</li>
+{% else %}
+  <li>
+    {{ nav_item.title }}
+    <ul>
+        {% for nav_item in nav_item.children %}
+            {% include "nav.html" %}
+        {% endfor %}
+    </ul>
+  </li>
+{% endif %}
diff --git a/docs/about/contributing.md b/docs/about/contributing.md
@@ -0,0 +1,4 @@
+# Testing Page
+
+See the [Home Page](/). All the other pages are for demonstration purposes
+with the navigation only.
diff --git a/docs/about/license.md b/docs/about/license.md
@@ -0,0 +1,4 @@
+# Testing Page
+
+See the [Home Page](/). All the other pages are for demonstration purposes
+with the navigation only.
diff --git a/docs/about/release-notes/version-1.md b/docs/about/release-notes/version-1.md
@@ -0,0 +1,4 @@
+# Testing Page
+
+See the [Home Page](/). All the other pages are for demonstration purposes
+with the navigation only.
diff --git a/docs/about/release-notes/version-2.md b/docs/about/release-notes/version-2.md
@@ -0,0 +1,4 @@
+# Testing Page
+
+See the [Home Page](/). All the other pages are for demonstration purposes
+with the navigation only.
diff --git a/docs/index.md b/docs/index.md
@@ -1,8 +1,11 @@
 # MkDocs Basic Theme
 
-This is a very basic theme for MkDocs with the goal of
-demonstrating all of the features with minimal HTML and CSS.
+This is a very basic theme for MkDocs with the goal of demonstrating all of
+the features with minimal HTML and CSS.
 
-The actual contents of this documentation is very minimal.
-Rather, you should look at the .html files in the `basic_theme`
-directory to see the example of the theme.
+## Adapting this theme
+
+If you want to use this theme as a base to create your own, it is best to
+download or fork the theme and start to modify it
+
+Make sure you read the MkDocs documentation regarding writing custom themes.
diff --git a/docs/page.md b/docs/page.md
diff --git a/docs/sub/page.md b/docs/sub/page.md
diff --git a/docs/user-guide/configuration.md b/docs/user-guide/configuration.md
@@ -0,0 +1,4 @@
+# Testing Page
+
+See the [Home Page](/). All the other pages are for demonstration purposes
+with the navigation only.
diff --git a/docs/user-guide/custom-themes.md b/docs/user-guide/custom-themes.md
@@ -0,0 +1,4 @@
+# Testing Page
+
+See the [Home Page](/). All the other pages are for demonstration purposes
+with the navigation only.
diff --git a/docs/user-guide/deploying-your-docs.md b/docs/user-guide/deploying-your-docs.md
@@ -0,0 +1,4 @@
+# Testing Page
+
+See the [Home Page](/). All the other pages are for demonstration purposes
+with the navigation only.
diff --git a/docs/user-guide/styling-your-docs.md b/docs/user-guide/styling-your-docs.md
@@ -0,0 +1,4 @@
+# Testing Page
+
+See the [Home Page](/). All the other pages are for demonstration purposes
+with the navigation only.
diff --git a/docs/user-guide/writing-your-docs.md b/docs/user-guide/writing-your-docs.md
@@ -0,0 +1,4 @@
+# Testing Page
+
+See the [Home Page](/). All the other pages are for demonstration purposes
+with the navigation only.
diff --git a/setup.py b/setup.py
@@ -0,0 +1,22 @@
+from setuptools import setup, find_packages
+
+VERSION = '1.0'
+
+
+setup(
+    name="mkdocs-basic-theme",
+    version=VERSION,
+    url='http://www.mkdocs.org',
+    license='BSD',
+    description='Minimal theme for MkDocs',
+    author='Dougal Matthews',
+    author_email='dougal@dougalmatthews.com.com',
+    packages=find_packages(),
+    include_package_data=True,
+    entry_points={
+        'mkdocs.themes': [
+            'basictheme = basic_theme',
+        ]
+    },
+    zip_safe=False
+)

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+recursive-include basic_theme .ico .js .css .png .html .eot .svg .ttf *.woff`
	`2`	`+recursive-exclude * __pycache__`
	`3`	`+recursive-exclude * *.py[co]`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +/*
 + * This JavaScript doesn't do anything. The file exists just to demonstrate
 + * including static assets from the HTML in themes.
 + */