Staticjinja

----------------------------------------------------------------------------------------

Fixed
^^^^^

* Fix links to external APIs in docs.

* Use the real readthedocs html theme when building docs locally.

----------------------------------------------------------------------------------------

Fixed
^^^^^

* Fix token to `actions/create-releasev1` in publish workflow

* Fix links throughout project.

------------------------------------------------------------------------------------------
Fixed
^^^^^

* Pin upload to PyPI action (`pypa/gh-action-pypi-publish`, used in the publish
workflow) to v1.4.1, instead of just master. Less prone to breakage.

------------------------------------------------------------------------------------------
Added
^^^^^

* Runnable and testable examples in ``examples/``. See ``examples/README.rst``
for more info.

* Code coverage at https://app.codecov.io/gh/staticjinja/staticjinja.

Changed
^^^^^^^

* Use GitHub Actions instead of Travis CI for CI testing.

* `Out` directory no longer needs to exist in CLI.

* Add more default arguments (logger, outpath, and encoding) to
``Site.__init__()`` so that ``Site.make_site()`` doesn't have to make them.

* Update requirements using ``piptools``. This dropped a dependency on
``pathtools``.

* Upload test results as artifacts to better diagnose failures in
GitHub Actions.

Deprecated
^^^^^^^^^^

Removed
^^^^^^^

* Python 2, 3.4, and 3.5 support. Now only Python 3.6 to 3.9 is supported.

* Remove broken ``filepath`` arg from ``Site.render_templates()``.
You shouldn't notice this though, since it crashed if was used :)

Fixed
^^^^^

* Fix tests and ``__main__.py`` to use ``Site.make_site()``, not deprecated
``staticjinja.make_site()``.

* Tests are now split up into separate files in the ``tests/`` directory.
The one monolithic file was intimidating. Some repeated boilerplate tests
were parameterized as well. The tests could still use some more cleanup in
general.

* Overhaul contributing info. Port CONTRIBUTING.md over to CONTRIBUTING.rst,
edit it, and then import this version in docs.

* Fix CWD logic loophole if ``Site.make_site()`` is called from an interpreter.

* Update use of deprecated ``inspect.getargspec()``.

* A few other trivial fixes.

------------------------------------------------------------------------------------------
* Improve Travis CI testing: Add Windows and OSX, stop testing python2,
add newer python3 versions, update tox.ini.

* Convert all print()s to logger.logs().

* Make CLI interface use Site.make_site() instead of deprecated make_site().

* Simplify style and how kwargs are passed around.

* Single-source the version info so it's always consistent.

* Minor fixes, updates, improvements to README, AUTHORS, CONTRIBUTING,
setup.py, __init__.py docstring,

* Rename Site._env to Site.env, making it publicly accessible, for instance
in custom rendering functions.

* Fix docstring for the expected signature of custom rendering rules so they
expect a staticjinja.Site as opposed to a jinja2.Environment

* Make is_{template,static,ignored,partial} functions be consistent with
taking template names(always use `/`), not file names (use os.path.sep),
making them consistent between OSs.
https://github.com/staticjinja/staticjinja/issues/88

* Update and improve docs, add .readthedocs.yml so that ReadTheDocs.org can
automatically pull from the repo and build docs on changes. Add a badge
for if the doc build passes. Add readthedocs build task as a GitHub check,
so new PRs and branches will automatically get this check.

* Change single example/ directory to a collection of examples in examples/,
and add in an example for using custom rendering rules to generate HTML from
markdown. This also fixes the totally wrong tutorial on the docs for how to
use custom rendering rules. See https://github.com/staticjinja/staticjinja/pull/102

* Update dependencies using pip-tools to automatically generate indirect
dependencies from direct dependencies:

* jinja2==2.6 -> jinja2==2.11.2
* argh==0.21.0 -> REMOVED
* argparse==1.2.1 -> REMOVED
* docopt==0.6.1 -> docopt==0.6.2
* easywatch==0.0.5 -> easywatch==0.0.5
* pathtools==0.1.2 -> pathtools==0.1.2
* watchdog==0.6.0 -> watchdog==0.10.3
* wsgiref==0.1.2 -> REMOVED
* NONE -> markupsafe==1.1.1

------------------------------------------------------------------------------------------
* Make README less verbose.

* Only warn about using deprecated ``staticpaths`` if ``staticpaths`` is
actually used.

* Updated easywatch to 0.0.5