From b377998b9c48b6571e94497fcaeaa56c6f9360bc Mon Sep 17 00:00:00 2001 From: Dougal Matthews Date: Sat, 27 Jun 2015 21:25:36 +0100 Subject: [PATCH] Update and package them --- MANIFEST.in | 3 ++ basic_theme/__init__.py | 0 basic_theme/base.html | 53 ++++++++++++++------------ basic_theme/css/theme.css | 4 ++ basic_theme/js/theme.js | 4 ++ basic_theme/nav.html | 17 +++++++++ docs/about/contributing.md | 4 ++ docs/about/license.md | 4 ++ docs/about/release-notes/version-1.md | 4 ++ docs/about/release-notes/version-2.md | 4 ++ docs/index.md | 13 ++++--- docs/page.md | 3 -- docs/sub/page.md | 3 -- docs/user-guide/configuration.md | 4 ++ docs/user-guide/custom-themes.md | 4 ++ docs/user-guide/deploying-your-docs.md | 4 ++ docs/user-guide/styling-your-docs.md | 4 ++ docs/user-guide/writing-your-docs.md | 4 ++ setup.py | 22 +++++++++++ 19 files changed, 123 insertions(+), 35 deletions(-) create mode 100644 MANIFEST.in create mode 100644 basic_theme/__init__.py create mode 100644 basic_theme/css/theme.css create mode 100644 basic_theme/nav.html create mode 100644 docs/about/contributing.md create mode 100644 docs/about/license.md create mode 100644 docs/about/release-notes/version-1.md create mode 100644 docs/about/release-notes/version-2.md delete mode 100644 docs/page.md delete mode 100644 docs/sub/page.md create mode 100644 docs/user-guide/configuration.md create mode 100644 docs/user-guide/custom-themes.md create mode 100644 docs/user-guide/deploying-your-docs.md create mode 100644 docs/user-guide/styling-your-docs.md create mode 100644 docs/user-guide/writing-your-docs.md create mode 100755 setup.py diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..f52831e --- /dev/null +++ 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 new file mode 100644 index 0000000..e69de29 diff --git a/basic_theme/base.html b/basic_theme/base.html index bd21ca4..1f0d83c 100644 --- a/basic_theme/base.html +++ b/basic_theme/base.html @@ -24,6 +24,14 @@ {% endif %} + + + + +
@@ -126,11 +126,16 @@

Next and previous links

--> {% if next_page or previous_page %}
- {% if next_page %} - Next Page - {% endif %} {% if previous_page %} - Previous Page + ← Previous Page + {% else %} + ← Previous Page + {% endif %} + - + {% if next_page %} + Next Page → + {% else %} + Next Page → {% endif %}
{% endif %} @@ -171,7 +176,7 @@

Show the table of contents for the current page

- Built with MkDocs using a theme provided by Read the Docs. + Built with MkDocs. +{% if not nav_item.children %} +
  • + {{ nav_item.title }} +
    • +{% else %} +
  • + {{ nav_item.title }} + +
    • +{% endif %} diff --git a/docs/about/contributing.md b/docs/about/contributing.md new file mode 100644 index 0000000..398705f --- /dev/null +++ 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 new file mode 100644 index 0000000..398705f --- /dev/null +++ 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 new file mode 100644 index 0000000..398705f --- /dev/null +++ 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 new file mode 100644 index 0000000..398705f --- /dev/null +++ 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 index 072b678..08e2c41 100644 --- 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 deleted file mode 100644 index 92698ac..0000000 --- a/docs/page.md +++ /dev/null @@ -1,3 +0,0 @@ -# Testing Page - -This page exists simply to demonstrate sub pages with the theme. diff --git a/docs/sub/page.md b/docs/sub/page.md deleted file mode 100644 index 92698ac..0000000 --- a/docs/sub/page.md +++ /dev/null @@ -1,3 +0,0 @@ -# Testing Page - -This page exists simply to demonstrate sub pages with the theme. diff --git a/docs/user-guide/configuration.md b/docs/user-guide/configuration.md new file mode 100644 index 0000000..398705f --- /dev/null +++ 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 new file mode 100644 index 0000000..398705f --- /dev/null +++ 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 new file mode 100644 index 0000000..398705f --- /dev/null +++ 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 new file mode 100644 index 0000000..398705f --- /dev/null +++ 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 new file mode 100644 index 0000000..398705f --- /dev/null +++ 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 new file mode 100755 index 0000000..95efde4 --- /dev/null +++ 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 +)