diff --git a/README.md b/README.md index 379f906..46df603 100644 --- a/README.md +++ b/README.md @@ -30,12 +30,13 @@ After installing `poetry`, enter `poetry install` to create the development envi To preview the documentation that will be in GitHub Pages, enter `poetry run mkdocs serve`. -The documentation must be written in strict Markdown: +The documentation must be written in strict Markdown: blank line before a new list; line breaks are two spaces; indentation is 4 spaces. -To build the documentation in the `docs/` folder from the `src/docs` files, +To build the documentation in the `docs/` folder from the `src/docs` files, first enter +`poetry install` to update your development environment, then enter `poetry run mkdocs build`. -(Don't use `mkdocs gh-deploy` because it pushes untracked and other files, +(Don't use `mkdocs gh-deploy` because it pushes untracked and other files, without giving you a chance to check what will be pushed.) When a new version of the library is to be put on PyPI: diff --git a/docs/404.html b/docs/404.html index 9e3c57b..7660313 100644 --- a/docs/404.html +++ b/docs/404.html @@ -12,7 +12,7 @@ - + @@ -20,7 +20,7 @@ - + @@ -832,7 +832,7 @@
{"use strict";/*!
+ * escape-html
+ * Copyright(c) 2012-2013 TJ Holowaychuk
+ * Copyright(c) 2015 Andreas Lubbe
+ * Copyright(c) 2015 Tiancheng "Timothy" Gu
+ * MIT Licensed
+ */var Va=/["'&<>]/;qn.exports=za;function za(e){var t=""+e,r=Va.exec(t);if(!r)return t;var o,n="",i=0,a=0;for(i=r.index;i