From 6766041328ac92361ba14436f7a21f8f0996052f Mon Sep 17 00:00:00 2001
From: Quinn Casey <quinn@quinncasey.com>
Date: Thu, 12 May 2022 09:15:55 -0700
Subject: [PATCH] Add myst_parser for sphinx, changelog to md
---
Pipfile | 1 +
Pipfile.lock | 45 +++++++++++++++++++++++++++++++++++++++------
docs/conf.py | 6 +++++-
docs/index.rst | 2 +-
docs/setup.rst | 2 +-
5 files changed, 47 insertions(+), 9 deletions(-)
diff --git a/Pipfile b/Pipfile
index c38d8323d..13644a23c 100644
--- a/Pipfile
+++ b/Pipfile
@@ -69,3 +69,4 @@ sphinx_rtd_theme = "*"
tox = "*"
black = "*"
pre-commit = "*"
+myst-parser = "*"
diff --git a/Pipfile.lock b/Pipfile.lock
index 8516b77d0..985f9fdb1 100644
--- a/Pipfile.lock
+++ b/Pipfile.lock
@@ -1,7 +1,7 @@
{
"_meta": {
"hash": {
- "sha256": "9573af313c811561d467d814c52c6bd1439bc48e3b31d7f56afed5f0ebe4b648"
+ "sha256": "edaf53125fd5a0dc3aff5b75e188523ef3b7bc29bda792ee78ee67506e0b831d"
},
"pipfile-spec": 6,
"requires": {},
@@ -99,7 +99,6 @@
"sha256:f04e857b59d9d1ccc39ce2da1021d196e47234873820cbeaad210724b1ee28ac",
"sha256:fadbfe37f74051d024037f223b8e001611eac868b5c5b06144ef4d8b799862f2"
],
- "index": "pypi",
"markers": "python_version < '3.9'",
"version": "==0.2.1"
},
@@ -202,7 +201,7 @@
"sha256:2857e29ff0d34db842cd7ca3230549d1a697f96ee6d3fb071cfa6c7393832597",
"sha256:6881edbebdb17b39b4eaaa821b438bf6eddffb4468cf344f09f89def34a8b1df"
],
- "markers": "python_version >= '3'",
+ "markers": "python_version >= '3.5'",
"version": "==2.0.12"
},
"click": {
@@ -1585,7 +1584,7 @@
"sha256:2857e29ff0d34db842cd7ca3230549d1a697f96ee6d3fb071cfa6c7393832597",
"sha256:6881edbebdb17b39b4eaaa821b438bf6eddffb4468cf344f09f89def34a8b1df"
],
- "markers": "python_version >= '3'",
+ "markers": "python_version >= '3.5'",
"version": "==2.0.12"
},
"click": {
@@ -1597,7 +1596,9 @@
"version": "==8.1.3"
},
"coverage": {
- "extras": [],
+ "extras": [
+ "toml"
+ ],
"hashes": [
"sha256:03e2a7826086b91ef345ff18742ee9fc47a6839ccd517061ef8fa1976e652ce9",
"sha256:07e6db90cd9686c767dcc593dff16c8c09f9814f5e9c51034066cad3373b914d",
@@ -1752,6 +1753,14 @@
"markers": "python_version >= '3.7'",
"version": "==3.1.2"
},
+ "markdown-it-py": {
+ "hashes": [
+ "sha256:93de681e5c021a432c63147656fe21790bc01231e0cd2da73626f1aa3ac0fe27",
+ "sha256:cf7e59fed14b5ae17c0006eff14a2d9a00ed5f3a846148153899a0224e2c07da"
+ ],
+ "markers": "python_version >= '3.7'",
+ "version": "==2.1.0"
+ },
"markupsafe": {
"hashes": [
"sha256:0212a68688482dc52b2d45013df70d169f542b7394fc744c02a57374a4207003",
@@ -1798,6 +1807,22 @@
"markers": "python_version >= '3.7'",
"version": "==2.1.1"
},
+ "mdit-py-plugins": {
+ "hashes": [
+ "sha256:b1279701cee2dbf50e188d3da5f51fee8d78d038cdf99be57c6b9d1aa93b4073",
+ "sha256:ecc24f51eeec6ab7eecc2f9724e8272c2fb191c2e93cf98109120c2cace69750"
+ ],
+ "markers": "python_version ~= '3.6'",
+ "version": "==0.3.0"
+ },
+ "mdurl": {
+ "hashes": [
+ "sha256:6a8f6804087b7128040b2fb2ebe242bdc2affaeaa034d5fc9feeed30b443651b",
+ "sha256:f79c9709944df218a4cdb0fcc0b0c7ead2f44594e3e84dc566606f04ad749c20"
+ ],
+ "markers": "python_version >= '3.7'",
+ "version": "==0.1.1"
+ },
"mypy-extensions": {
"hashes": [
"sha256:090fedd75945a69ae91ce1303b5824f428daf5a028d2f6ab8a299250a846f15d",
@@ -1805,6 +1830,14 @@
],
"version": "==0.4.3"
},
+ "myst-parser": {
+ "hashes": [
+ "sha256:1635ce3c18965a528d6de980f989ff64d6a1effb482e1f611b1bfb79e38f3d98",
+ "sha256:4c076d649e066f9f5c7c661bae2658be1ca06e76b002bb97f02a09398707686c"
+ ],
+ "index": "pypi",
+ "version": "==0.17.2"
+ },
"nodeenv": {
"hashes": [
"sha256:3ef13ff90291ba2a4a7a4ff9a979b63ffdd00a464dbe04acf0ea6471517a4c2b",
@@ -2096,7 +2129,7 @@
"sha256:939de3e7a6161af0c887ef91b7d41a53e7c5a1ca976325f429cb46ea9bc30ecc",
"sha256:de526c12914f0c550d15924c62d72abc48d6fe7364aa87328337a31007fe8a4f"
],
- "markers": "python_version >= '3.7'",
+ "markers": "python_version < '3.11'",
"version": "==2.0.1"
},
"tox": {
diff --git a/docs/conf.py b/docs/conf.py
index 0f30772ea..096ccc1af 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -14,13 +14,17 @@ extensions = [
"sphinx.ext.imgmath",
"sphinx.ext.viewcode",
"sphinx_rtd_theme",
+ "myst_parser",
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
# The suffix of source filenames.
-source_suffix = ".rst"
+source_suffix = {
+ ".rst": "restructuredtext",
+ ".md": "markdown",
+}
# The encoding of source files.
# source_encoding = 'utf-8-sig'
diff --git a/docs/index.rst b/docs/index.rst
index 040d39e4f..715fef588 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -52,7 +52,7 @@ resources in the documentation:
* Paperless is now integrated with a
:ref:`task processing queue <setup-task_processor>` that tells you
at a glance when and why something is not working.
-* The :ref:`changelog <paperless_changelog>` contains a detailed list of all changes
+* The :doc:`changelog </changelog>` contains a detailed list of all changes
in paperless-ngx.
Contents
diff --git a/docs/setup.rst b/docs/setup.rst
index d3290b432..ffc81791b 100644
--- a/docs/setup.rst
+++ b/docs/setup.rst
@@ -513,7 +513,7 @@ how you installed paperless.
This setup describes how to update an existing paperless Docker installation.
The important things to keep in mind are as follows:
-* Read the :ref:`changelog <paperless_changelog>` and take note of breaking changes.
+* Read the :doc:`changelog </changelog>` and take note of breaking changes.
* You should decide if you want to stick with SQLite or want to migrate your database
to PostgreSQL. See :ref:`setup-sqlite_to_psql` for details on how to move your data from
SQLite to PostgreSQL. Both work fine with paperless. However, if you already have a