From 637038f8765be93aa3aae2b5d175532ba6035f49 Mon Sep 17 00:00:00 2001 From: Gerry Ntabuhashe Date: Fri, 21 Jun 2019 10:07:57 +0200 Subject: [PATCH] Prepare version 1.0.1 release. This fixes #1 - Documentation has been updated - The version has been updated in the setup --- README.md | 6 +++++- docs/release-notes.md | 6 ++++++ mkdocs.yml | 1 + setup.py | 2 +- 4 files changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7ffd4e8..602c059 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ What makes this plugin particular, is that: 1. The ability to override the default design to make it fit your needs 1. No layout issues 1. No conflict with the theme design -1. Table of content integrated in the PDF +1. Table of contents integrated in the PDF ## Requirements @@ -29,6 +29,10 @@ What makes this plugin particular, is that: - [MacOS][weasyprint-macos] - [Windows][weasyprint-windows] +## Limitation + +The PDF version of the documentation will not be created if the used generated page content's is not enclosed in an `
` tag or in a `
` tag with property `role="main"`. + ## Installation Install the package with `pip`: diff --git a/docs/release-notes.md b/docs/release-notes.md index 62d4431..096b4c5 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -14,6 +14,12 @@ pip show mkpdfs-mkdocs ``` ## Changelog +### 1.0.1 - June 28, 2019 + +* The plugin was breaking the documentation generation (#1). + Now if the theme is not compatible, the PDF version of the documentation won't be created and a warning will be displayed without breaking the documentation generation. +* Enhance the view by adding a section page in the documentation (#2) + ### 1.0.0 - April 15, 2019 * Initial release diff --git a/mkdocs.yml b/mkdocs.yml index 63ca8b0..6511c1e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,5 +1,6 @@ site_name: MkPDFs for MkDocs site_author: Comwes +site_url: https://comwes.github.io/mkpdfs-mkdocs-plugin/ extra_css: - 'stylesheets/extra.css' theme: diff --git a/setup.py b/setup.py index d994d49..f4db864 100644 --- a/setup.py +++ b/setup.py @@ -10,7 +10,7 @@ setup( name='mkpdfs-mkdocs', - version='1.0.0', + version='1.0.1', url='https://mkpdfs.comwes.eu', license='GPLv3', author='Comwes',