From e08eb91d28ef683ab9b5e39e681420968ea197af Mon Sep 17 00:00:00 2001 From: Dougal Matthews Date: Mon, 13 Oct 2014 20:45:54 +0100 Subject: [PATCH 1/8] Django Rest -> MkDocs Oops. --- docs/about/release-notes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/about/release-notes.md b/docs/about/release-notes.md index ab7f7c42..1ebf79bd 100644 --- a/docs/about/release-notes.md +++ b/docs/about/release-notes.md @@ -4,7 +4,7 @@ ## Upgrading -To upgrade Django REST framework to the latest version, use pip: +To upgrade MkDocs to the latest version, use pip: pip install -U mkdocs From d45288b56d3fc74d154cbf45300db6fdf3f0ffd3 Mon Sep 17 00:00:00 2001 From: Dougal Matthews Date: Mon, 13 Oct 2014 21:16:47 +0100 Subject: [PATCH 2/8] Updated docs for multiple theme directories Originally changed in 8f3c2b0. --- docs/user-guide/configuration.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/user-guide/configuration.md b/docs/user-guide/configuration.md index e0c326c0..8b8a8ff9 100644 --- a/docs/user-guide/configuration.md +++ b/docs/user-guide/configuration.md @@ -39,7 +39,7 @@ When set, provides a link to your GitHub or Bitbucket repository on each page. Set the site description. This will add a meta tag to the generated HTML header. **default**: `null` -#### site_author +#### site_author Set the name of the author. This will add a meta tag to the generated HTML header. @@ -72,7 +72,7 @@ Here's a simple example that would cause the build stage to create three pages: Assuming the `docs_dir` setting was left with the default value of `docs`, the source files for this site's build process would be `docs/index.md`, `docs/user-guide.md` and `docs/about.md`. -If you have a lot of project documentation you might choose to use headings to break up your site navigation by category. You can do so by including an extra string in the page configuration for any pages that require a navigation heading, like so: +If you have a lot of project documentation you might choose to use headings to break up your site navigation by category. You can do so by including an extra string in the page configuration for any pages that require a navigation heading, like so: pages: - ['index.md', 'Introduction'] @@ -108,7 +108,7 @@ You would include the following setting to use the custom theme directory: theme_dir: 'custom_theme' -If used, then this setting overrides any `theme` configuration value. +If used in combination with the `theme` configuration value a custom theme can be used to replace only specific parts of a themes templates. For example, with the above layout and if you set your `theme: mkdocs` then the base.html file would replace that in the theme but otherwise it would remain the same. This is useful if you want to make small adjustments to an existing theme. **default**: `null` From 5d4b918c498c4240a11914ed177ddd402710298a Mon Sep 17 00:00:00 2001 From: Dougal Matthews Date: Mon, 13 Oct 2014 21:21:45 +0100 Subject: [PATCH 3/8] Remove Lorem ipsum --- docs/user-guide/configuration.md | 14 +++----------- 1 file changed, 3 insertions(+), 11 deletions(-) diff --git a/docs/user-guide/configuration.md b/docs/user-guide/configuration.md index 8b8a8ff9..3c1ebd1c 100644 --- a/docs/user-guide/configuration.md +++ b/docs/user-guide/configuration.md @@ -139,15 +139,15 @@ If you're using another source code control you'll want to check its documentati #### include_search -Mea et graeci persecuti, sit possit neglegentur ex. Nam modus maluisset id. Praesent laboramus expetendis an vis. Mea scripta eleifend et. Ex zril quidam facilis nec, eu inani errem expetendis eum. Falli electram periculis te ius, sed nihil saperet cu. Possit quodsi cu sea, usu ei saperet lobortis adolescens. +TODO #### include_404 -Lorem ipsum dolor sit amet, ex usu velit harum dignissim. Graeco saperet tibique ea mea. Mel vocent veritus assentior ne, ponderum dissentiunt nec eu. No civibus commune duo, nec in mollis regione eruditi, nec feugiat accumsan interesset te. Natum accusam legendos sea no, te eam libris tamquam, ius fabulas vocibus rationibus ad. Eum ex sonet nostrum argumentum, mel persius cotidieque repudiandae in, cum legendos patrioque in. +TODO #### include_sitemap -Consul percipitur usu an, no dico facer inermis cum. Eum ea mentitum accommodare. An sea periculis euripidis, dicant minimum patrioque at vis. Justo atomorum abhorreant vel in. Eos agam intellegam disputando at, zril consul nostrud ut eum. +TODO --> ## Preview controls @@ -180,14 +180,6 @@ As with all settings, you can set this from the command line, which can be usful **default**: `'127.0.0.1:8000'` - - ## Formatting options #### markdown_extensions From a3507d28b42cfd8c84df9c0382b591c4b2a9fb34 Mon Sep 17 00:00:00 2001 From: Dougal Matthews Date: Mon, 13 Oct 2014 20:33:04 +0100 Subject: [PATCH 4/8] Add BSD license file --- LICENSE | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..cf6234d2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,26 @@ +Copyright © 2014, Tom Christie. All rights reserved. + +Redistribution and use in source and binary forms, with or +without modification, are permitted provided that the following +conditions are met: + +Redistributions of source code must retain the above copyright +notice, this list of conditions and the following disclaimer. +Redistributions in binary form must reproduce the above copyright +notice, this list of conditions and the following disclaimer in +the documentation and/or other materials provided with the +distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND +CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, +INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR +CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF +USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED +AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN +ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. From eb3a1538205d680acc950f94d9225b00a3ebd2a8 Mon Sep 17 00:00:00 2001 From: Dougal Matthews Date: Mon, 13 Oct 2014 21:28:15 +0100 Subject: [PATCH 5/8] Add a note about supported Python versions --- docs/index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/index.md b/docs/index.md index 38a585fc..c59b23ab 100644 --- a/docs/index.md +++ b/docs/index.md @@ -47,6 +47,8 @@ In order to install MkDocs you'll need [Python][python] installed on your system $ pip --version pip 1.5.2 +MkDocs supports Python 2.6, 2.7, 3.3 and 3.4. + Install the `mkdocs` package using pip: $ pip install mkdocs From fb21ba58011fbc397e99323a2bf4bf913643bd34 Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Mon, 13 Oct 2014 16:30:32 -0700 Subject: [PATCH 6/8] Fix RTD theme toc when pages don't have children. --- mkdocs/themes/readthedocs/toc.html | 39 ++++++++++++++++++------------ 1 file changed, 24 insertions(+), 15 deletions(-) diff --git a/mkdocs/themes/readthedocs/toc.html b/mkdocs/themes/readthedocs/toc.html index f580f3f3..45b58b9f 100644 --- a/mkdocs/themes/readthedocs/toc.html +++ b/mkdocs/themes/readthedocs/toc.html @@ -1,18 +1,27 @@
    {% for nav_item in nav %} - {% for nav_item in nav_item.children %} -
  • - {{ nav_item.title }} - {% if nav_item == current_page %} - - {% endif %} -
    • - {% endfor %}{% endfor %} + {% if nav_item.children %} + {% for nav_item in nav_item.children %} +
  • + {{ nav_item.title }} + {% if nav_item == current_page %} + + {% endif %} +
    • + {% endfor %} + {% else %} +
  • + {{ nav_item.title }} +
    • + {% endif %} + + {% endfor %}
+ From 3d679f174927d3772a14ae4462024cf8bbd4070a Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Mon, 13 Oct 2014 16:38:44 -0700 Subject: [PATCH 7/8] Link to RTD footer --- mkdocs/themes/readthedocs/footer.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs/themes/readthedocs/footer.html b/mkdocs/themes/readthedocs/footer.html index bdc66a03..52f276bf 100644 --- a/mkdocs/themes/readthedocs/footer.html +++ b/mkdocs/themes/readthedocs/footer.html @@ -18,5 +18,5 @@

- Built with MkDocs, using the Read the Docs theme. + Built with MkDocs, using a theme provided by Read the Docs. From 0f5b6e14fad4a05b99e50c7a6523e35778dca467 Mon Sep 17 00:00:00 2001 From: Dougal Matthews Date: Tue, 14 Oct 2014 16:11:29 +0100 Subject: [PATCH 8/8] Update index.md Closes #161 --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index c59b23ab..65b5f1a5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -26,7 +26,7 @@ There's a stack of good looking themes included by default. Choose from bootstra #### Preview your site as you work. -The built-in devserver allows you to preview your documentation as your writing it. It will even auto-reload whenever you save any changes, so all you need to do to see your latest edits is refresh your browser. +The built-in devserver allows you to preview your documentation as you're writing it. It will even auto-reload whenever you save any changes, so all you need to do to see your latest edits is refresh your browser. #### Easy to customize.