summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Lord <davidism@gmail.com>2020-04-09 13:40:52 -0700
committerDavid Lord <davidism@gmail.com>2020-04-09 13:40:52 -0700
commitd1ba8be61622606de69aec57b0899ede1bc6fc9d (patch)
tree1dfcb79727288dfe23518ebf12117a997fd39d1f
parent271e92c77fcae393c2839927b470075514821e7a (diff)
parent7aa82423deafbc948de36ad9129701633cb1cad8 (diff)
downloadmarkupsafe-d1ba8be61622606de69aec57b0899ede1bc6fc9d.tar.gz
Merge branch '1.1.x'
-rw-r--r--.readthedocs.yaml8
-rw-r--r--CHANGES.rst14
-rw-r--r--docs/conf.py15
-rw-r--r--docs/license.rst4
-rw-r--r--docs/requirements.txt6
5 files changed, 29 insertions, 18 deletions
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 0000000..af23210
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,8 @@
+version: 2
+python:
+ install:
+ - method: pip
+ path: .
+ - requirements: docs/requirements.txt
+sphinx:
+ builder: dirhtml
diff --git a/CHANGES.rst b/CHANGES.rst
index a846912..39c7227 100644
--- a/CHANGES.rst
+++ b/CHANGES.rst
@@ -12,9 +12,7 @@ Version 1.1.1
Released 2019-02-23
- Fix segfault when ``__html__`` method raises an exception when using
- the C speedups. The exception is now propagated correctly. (`#109`_)
-
-.. _#109: https://github.com/pallets/markupsafe/pull/109
+ the C speedups. The exception is now propagated correctly. :pr:`109`
Version 1.1.0
@@ -24,15 +22,11 @@ Released 2018-11-05
- Drop support for Python 2.6 and 3.3.
- Build wheels for Linux, Mac, and Windows, allowing systems without
- a compiler to take advantage of the C extension speedups. (`#104`_)
+ a compiler to take advantage of the C extension speedups. :pr:`104`
- Use newer CPython API on Python 3, resulting in a 1.5x speedup.
- (`#64`_)
+ :pr`64`
- ``escape`` wraps ``__html__`` result in ``Markup``, consistent with
- documented behavior. (`#69`_)
-
-.. _#64: https://github.com/pallets/markupsafe/pull/64
-.. _#69: https://github.com/pallets/markupsafe/pull/69
-.. _#104: https://github.com/pallets/markupsafe/pull/104
+ documented behavior. :pr:`69`
Version 1.0
diff --git a/docs/conf.py b/docs/conf.py
index 46123a3..881f1ab 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -4,19 +4,26 @@ from pallets_sphinx_themes import ProjectLink
# Project --------------------------------------------------------------
project = "MarkupSafe"
-copyright = "2010 Pallets Team"
-author = "Pallets Team"
+copyright = "2010 Pallets"
+author = "Pallets"
release, version = get_version("MarkupSafe")
# General --------------------------------------------------------------
master_doc = "index"
-extensions = ["sphinx.ext.autodoc", "sphinx.ext.intersphinx", "pallets_sphinx_themes"]
+extensions = [
+ "sphinx.ext.autodoc",
+ "sphinx.ext.intersphinx",
+ "pallets_sphinx_themes",
+ "sphinxcontrib.log_cabinet",
+ "sphinx_issues",
+]
intersphinx_mapping = {"python": ("https://docs.python.org/3/", None)}
+issues_github_path = "pallets/markupsafe"
# HTML -----------------------------------------------------------------
-html_theme = "flask"
+html_theme = "jinja"
html_theme_options = {"index_sidebar_logo": False}
html_context = {
"project_links": [
diff --git a/docs/license.rst b/docs/license.rst
index cc8c2f3..a53a98c 100644
--- a/docs/license.rst
+++ b/docs/license.rst
@@ -1,4 +1,4 @@
-License
-=======
+BSD-3-Clause License
+====================
.. include:: ../LICENSE.rst
diff --git a/docs/requirements.txt b/docs/requirements.txt
index 295f450..7cad0cf 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -1,2 +1,4 @@
-Sphinx~=1.8.0
-Pallets-Sphinx-Themes~=1.1.0
+Sphinx~=3.0.0
+Pallets-Sphinx-Themes~=1.2.3
+sphinxcontrib-log-cabinet~=1.0.1
+sphinx-issues~=1.2.0