Prepare version 1.0.1 release. This fixes #1

- Documentation has been updated - The version has been updated in the setup
comwes · Jun 21, 2019 · 637038f · 637038f
1 parent 67f992f
commit 637038f
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 2 deletions.
diff --git 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 `<article>` tag  or in a `<div>` tag with property `role="main"`.
+
 ## Installation
 
 Install the package with `pip`:

diff --git a/docs/release-notes.md b/docs/release-notes.md
@@ -14,6 +14,12 @@ pip show mkpdfs-mkdocs
 ```
 
 ## Changelog
+### 1.0.1 <small>- June 28, 2019</small>
+
+* 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 <small>- April 15, 2019</small>
 
 * Initial release
diff --git 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
@@ -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',