From 2eb730a6dd97bfac4ec0daa0b0392bd18d808517 Mon Sep 17 00:00:00 2001
From: Luke Murphy <lukewm@riseup.net>
Date: Mon, 25 Nov 2019 11:18:48 +0700
Subject: [PATCH] Use more standard docs folder
---
{documentation => docs}/Makefile | 0
{documentation => docs}/source/_static/.git-dont-delete | 0
{documentation => docs}/source/_templates/.git-dont-delete | 0
{documentation => docs}/source/changelog.rst | 0
{documentation => docs}/source/code-of-conduct.rst | 0
{documentation => docs}/source/conf.py | 0
{documentation => docs}/source/contribute.rst | 0
{documentation => docs}/source/example.rst | 0
{documentation => docs}/source/index.rst | 0
{documentation => docs}/source/install.rst | 0
{documentation => docs}/source/modules-api.rst | 0
{documentation => docs}/source/other-impls.rst | 0
{documentation => docs}/source/upgrade.rst | 0
setup.cfg | 4 ++--
tox.ini | 2 +-
15 files changed, 3 insertions(+), 3 deletions(-)
rename {documentation => docs}/Makefile (100%)
rename {documentation => docs}/source/_static/.git-dont-delete (100%)
rename {documentation => docs}/source/_templates/.git-dont-delete (100%)
rename {documentation => docs}/source/changelog.rst (100%)
rename {documentation => docs}/source/code-of-conduct.rst (100%)
rename {documentation => docs}/source/conf.py (100%)
rename {documentation => docs}/source/contribute.rst (100%)
rename {documentation => docs}/source/example.rst (100%)
rename {documentation => docs}/source/index.rst (100%)
rename {documentation => docs}/source/install.rst (100%)
rename {documentation => docs}/source/modules-api.rst (100%)
rename {documentation => docs}/source/other-impls.rst (100%)
rename {documentation => docs}/source/upgrade.rst (100%)
diff --git a/documentation/Makefile b/docs/Makefile
similarity index 100%
rename from documentation/Makefile
rename to docs/Makefile
diff --git a/documentation/source/_static/.git-dont-delete b/docs/source/_static/.git-dont-delete
similarity index 100%
rename from documentation/source/_static/.git-dont-delete
rename to docs/source/_static/.git-dont-delete
diff --git a/documentation/source/_templates/.git-dont-delete b/docs/source/_templates/.git-dont-delete
similarity index 100%
rename from documentation/source/_templates/.git-dont-delete
rename to docs/source/_templates/.git-dont-delete
diff --git a/documentation/source/changelog.rst b/docs/source/changelog.rst
similarity index 100%
rename from documentation/source/changelog.rst
rename to docs/source/changelog.rst
diff --git a/documentation/source/code-of-conduct.rst b/docs/source/code-of-conduct.rst
similarity index 100%
rename from documentation/source/code-of-conduct.rst
rename to docs/source/code-of-conduct.rst
diff --git a/documentation/source/conf.py b/docs/source/conf.py
similarity index 100%
rename from documentation/source/conf.py
rename to docs/source/conf.py
diff --git a/documentation/source/contribute.rst b/docs/source/contribute.rst
similarity index 100%
rename from documentation/source/contribute.rst
rename to docs/source/contribute.rst
diff --git a/documentation/source/example.rst b/docs/source/example.rst
similarity index 100%
rename from documentation/source/example.rst
rename to docs/source/example.rst
diff --git a/documentation/source/index.rst b/docs/source/index.rst
similarity index 100%
rename from documentation/source/index.rst
rename to docs/source/index.rst
diff --git a/documentation/source/install.rst b/docs/source/install.rst
similarity index 100%
rename from documentation/source/install.rst
rename to docs/source/install.rst
diff --git a/documentation/source/modules-api.rst b/docs/source/modules-api.rst
similarity index 100%
rename from documentation/source/modules-api.rst
rename to docs/source/modules-api.rst
diff --git a/documentation/source/other-impls.rst b/docs/source/other-impls.rst
similarity index 100%
rename from documentation/source/other-impls.rst
rename to docs/source/other-impls.rst
diff --git a/documentation/source/upgrade.rst b/docs/source/upgrade.rst
similarity index 100%
rename from documentation/source/upgrade.rst
rename to docs/source/upgrade.rst
diff --git a/setup.cfg b/setup.cfg
index 719e558..e277df8 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -51,8 +51,8 @@ where = .
[build_sphinx]
all_files = 1
-build-dir = documentation/build
-source-dir = documentation/source
+build-dir = docs/build
+source-dir = docs/source
warning-is-error = True
[options.extras_require]
diff --git a/tox.ini b/tox.ini
index 9faf3af..9b479de 100644
--- a/tox.ini
+++ b/tox.ini
@@ -52,7 +52,7 @@ commands = python -m setup build_sphinx
[testenv:docs-livereload]
description = invoke sphinx-autobuild to build and reload the documentation
-commands = python -m sphinx_autobuild documentation/source documentation/build
+commands = python -m sphinx_autobuild docs/source docs/build
deps = sphinx-autobuild>=0.7.1,<1.0
extras = docs