diff --git a/NEWS b/NEWS index f97cd27498a3cf6d70839286fdfac8e59144318d_TkVXUw==..5a576731bb589fef6b81a62c8084de4fae8abda6_TkVXUw== 100644 --- a/NEWS +++ b/NEWS @@ -162,7 +162,7 @@ - Style improvement to zoneinfo.tzfile that was confusing to static type checkers. Reported and fixed by @quodlibetor (gh pr #485) - Several unused imports were removed by @jdufresne. (gh pr #486) -- Switched isinstance(*, collections.Callable) to callable, which is available +- Switched ``isinstance(*, collections.Callable)`` to callable, which is available on all supported Python versions. Implemented by @jdufresne (gh pr #612) - Added CONTRIBUTING.md (gh pr #533) - Added AUTHORS.md (gh pr #542) @@ -609,7 +609,7 @@ Andreas Köhler. - Implemented internal timezone information with binary - timezone files [1]. datautil.tz.gettz() function will now + timezone files. datautil.tz.gettz() function will now try to use the system timezone files, and fallback to the internal versions. It's also possible to ask for the internal versions directly by using @@ -628,9 +628,7 @@ - Fixed other reported bugs. -[1] http://www.twinsun.com/tz/tz-link.htm - Version 0.5 =========== @@ -633,8 +631,8 @@ Version 0.5 =========== -- Removed FREQ_ prefix from rrule frequency constants +- Removed ``FREQ_`` prefix from rrule frequency constants WARNING: this breaks compatibility with previous versions. - Fixed rrule.between() for cases where "after" is achieved diff --git a/changelog.d/692.doc.rst b/changelog.d/692.doc.rst new file mode 100644 index 0000000000000000000000000000000000000000..5a576731bb589fef6b81a62c8084de4fae8abda6_Y2hhbmdlbG9nLmQvNjkyLmRvYy5yc3Q= --- /dev/null +++ b/changelog.d/692.doc.rst @@ -0,0 +1,1 @@ +Added changelog to documentation. (gh issue #692, gh pr #707) diff --git a/changelog.d/707.doc.rst b/changelog.d/707.doc.rst new file mode 100644 index 0000000000000000000000000000000000000000..5a576731bb589fef6b81a62c8084de4fae8abda6_Y2hhbmdlbG9nLmQvNzA3LmRvYy5yc3Q= --- /dev/null +++ b/changelog.d/707.doc.rst @@ -0,0 +1,1 @@ +Changed the default theme to sphinx_rtd_theme, and changed the sphinx configuration to go along with that. (gh pr #707) diff --git a/docs/changelog.rst b/docs/changelog.rst new file mode 100644 index 0000000000000000000000000000000000000000..5a576731bb589fef6b81a62c8084de4fae8abda6_ZG9jcy9jaGFuZ2Vsb2cucnN0 --- /dev/null +++ b/docs/changelog.rst @@ -0,0 +1,7 @@ +.. Changelog transcluded from the NEWS file + +========= +Changelog +========= + +.. include:: ../NEWS diff --git a/docs/conf.py b/docs/conf.py index f97cd27498a3cf6d70839286fdfac8e59144318d_ZG9jcy9jb25mLnB5..5a576731bb589fef6b81a62c8084de4fae8abda6_ZG9jcy9jb25mLnB5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -106,7 +106,7 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +html_theme = 'sphinx_rtd_theme' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the diff --git a/docs/index.rst b/docs/index.rst index f97cd27498a3cf6d70839286fdfac8e59144318d_ZG9jcy9pbmRleC5yc3Q=..5a576731bb589fef6b81a62c8084de4fae8abda6_ZG9jcy9pbmRleC5yc3Q= 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,5 +11,11 @@ Contents: .. toctree:: + :maxdepth: 1 + + Overview <self> + Changelog <changelog> + +.. toctree:: :maxdepth: 2 @@ -14,6 +20,5 @@ :maxdepth: 2 - self easter parser relativedelta diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt new file mode 100644 index 0000000000000000000000000000000000000000..5a576731bb589fef6b81a62c8084de4fae8abda6_ZG9jcy9yZXF1aXJlbWVudHMtZG9jcy50eHQ= --- /dev/null +++ b/docs/requirements-docs.txt @@ -0,0 +1,2 @@ +Sphinx>=1.7.3,<2 +sphinx_rtd_theme>=0.3.0 diff --git a/tox.ini b/tox.ini index f97cd27498a3cf6d70839286fdfac8e59144318d_dG94LmluaQ==..5a576731bb589fef6b81a62c8084de4fae8abda6_dG94LmluaQ== 100644 --- a/tox.ini +++ b/tox.ini @@ -53,7 +53,7 @@ [testenv:docs] description = invoke sphinx-build to build the HTML docs, check that URIs are valid basepython = python3.6 -deps = sphinx >= 1.6.3, < 2 +deps = -r docs/requirements-docs.txt {[testenv]deps} commands = sphinx-build -d "{toxworkdir}/docs_doctree" docs "{toxworkdir}/docs_out" {posargs:-W --color -bhtml} sphinx-build -d "{toxworkdir}/docs_doctree" docs "{toxworkdir}/docs_out" {posargs:-W --color -blinkcheck}