Merge branch 'rtd2'

mar10 · Nov 14, 2021 · 92080a4 · 92080a4
2 parents 3235a40 + bd8e5e8
commit 92080a4
Show file tree

Hide file tree

Showing 83 changed files with 407 additions and 37 deletions.
diff --git a/.gitignore b/.gitignore
@@ -9,8 +9,6 @@
 build/
 docs/source/_autosummary/
 docs/build/
-docs/sphinx/_autosummary/
-docs/sphinx/_build/
 docs/sphinx/_generated/
 docs/sphinx-build/
 htmlcov/
@@ -35,3 +33,4 @@ pip-wheel-metadata/
 wsgidav.yaml
 wsgidav_2x.yaml
 wsgidav_custom.yaml
+
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -14,7 +14,7 @@ build:
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
-   configuration: docs/sphinx/conf.py
+  configuration: docs/source/conf.py
 
 # If using Sphinx, optionally build your docs in additional formats such as PDF
 # formats:
@@ -23,4 +23,8 @@ sphinx:
 # Optionally declare the Python requirements required to build your docs
 python:
    install:
-   - requirements: docs/sphinx/requirements.txt
+     - requirements: docs/source/requirements.txt
+     - method: pip
+       path: .
+      #  extra_requirements:
+      #    - docs
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,7 +12,7 @@
   The new option `dir_browser.davmount_links` controls link display (default: false).
 - #185 Fix FileLikeQueue for Python 3
 - #222 Discrepancy between "getetag" property and ETag header
-- TODO: Support LibreOffice in dir_browser
+
 
 ## 3.1.2 / Unreleased
 

diff --git a/Pipfile b/Pipfile
@@ -4,7 +4,7 @@ verify_ssl = true
 name = "pypi"
 
 [dev-packages]
-black = "==21.9b0"
+black = "==21.10b0"
 Cheroot = "*"  # "~=8.5"
 cx_Freeze = {version = "*", os_name = "== 'nt'"}
 flake8 = "*"  # "~=3.8"

diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/make.bat b/docs/make.bat
@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd
diff --git a/docs/sphinx/Makefile → docs/source/Makefile b/docs/sphinx/Makefile → docs/source/Makefile
diff --git a/docs/THANKS → docs/source/THANKS b/docs/THANKS → docs/source/THANKS
diff --git a/...sphinx/_static/client_ubuntu13_davfs2.png → ...source/_static/client_ubuntu13_davfs2.png b/...sphinx/_static/client_ubuntu13_davfs2.png → ...source/_static/client_ubuntu13_davfs2.png
diff --git a/.../sphinx/_static/client_ubuntu13_files.png → .../source/_static/client_ubuntu13_files.png b/.../sphinx/_static/client_ubuntu13_files.png → .../source/_static/client_ubuntu13_files.png
diff --git a/...phinx/_static/client_ubuntu13_firefox.png → ...ource/_static/client_ubuntu13_firefox.png b/...phinx/_static/client_ubuntu13_firefox.png → ...ource/_static/client_ubuntu13_firefox.png
diff --git a/docs/sphinx/_static/client_win7_cmd.png → docs/source/_static/client_win7_cmd.png b/docs/sphinx/_static/client_win7_cmd.png → docs/source/_static/client_win7_cmd.png
diff --git a/...phinx/_static/client_win7_davexplorer.png → ...ource/_static/client_win7_davexplorer.png b/...phinx/_static/client_win7_davexplorer.png → ...ource/_static/client_win7_davexplorer.png
diff --git a/...hinx/_static/client_win7_fileexplorer.png → ...urce/_static/client_win7_fileexplorer.png b/...hinx/_static/client_win7_fileexplorer.png → ...urce/_static/client_win7_fileexplorer.png
diff --git a/docs/sphinx/_static/client_win7_ie11.png → docs/source/_static/client_win7_ie11.png b/docs/sphinx/_static/client_win7_ie11.png → docs/source/_static/client_win7_ie11.png
diff --git a/docs/sphinx/_static/img/Browser_MySQL.gif → docs/source/_static/img/Browser_MySQL.gif b/docs/sphinx/_static/img/Browser_MySQL.gif → docs/source/_static/img/Browser_MySQL.gif
diff --git a/...sphinx/_static/img/Browser_filesystem.png → ...source/_static/img/Browser_filesystem.png b/...sphinx/_static/img/Browser_filesystem.png → ...source/_static/img/Browser_filesystem.png
diff --git a/docs/sphinx/_static/img/Browser_virtual.png → docs/source/_static/img/Browser_virtual.png b/docs/sphinx/_static/img/Browser_virtual.png → docs/source/_static/img/Browser_virtual.png
diff --git a/...inx/_static/img/DAVExplorer_Mercurial.png → ...rce/_static/img/DAVExplorer_Mercurial.png b/...inx/_static/img/DAVExplorer_Mercurial.png → ...rce/_static/img/DAVExplorer_Mercurial.png
diff --git a/.../sphinx/_static/img/DAVExplorer_MySQL.gif → .../source/_static/img/DAVExplorer_MySQL.gif b/.../sphinx/_static/img/DAVExplorer_MySQL.gif → .../source/_static/img/DAVExplorer_MySQL.gif
diff --git a/...sphinx/_static/img/Explorer_Mercurial.png → ...source/_static/img/Explorer_Mercurial.png b/...sphinx/_static/img/Explorer_Mercurial.png → ...source/_static/img/Explorer_Mercurial.png
diff --git a/docs/sphinx/_static/img/Explorer_virtual.png → docs/source/_static/img/Explorer_virtual.png b/docs/sphinx/_static/img/Explorer_virtual.png → docs/source/_static/img/Explorer_virtual.png
diff --git a/...static/img/Nautilus_Connect to Server.png → ...static/img/Nautilus_Connect to Server.png b/...static/img/Nautilus_Connect to Server.png → ...static/img/Nautilus_Connect to Server.png
diff --git a/...x/_static/img/Nautilus_Enter Password.png → ...e/_static/img/Nautilus_Enter Password.png b/...x/_static/img/Nautilus_Enter Password.png → ...e/_static/img/Nautilus_Enter Password.png
diff --git a/...phinx/_static/img/Nautilus_Filesystem.png → ...ource/_static/img/Nautilus_Filesystem.png b/...phinx/_static/img/Nautilus_Filesystem.png → ...ource/_static/img/Nautilus_Filesystem.png
diff --git a/docs/sphinx/_static/img/OpenOffice_logon.png → docs/source/_static/img/OpenOffice_logon.png b/docs/sphinx/_static/img/OpenOffice_logon.png → docs/source/_static/img/OpenOffice_logon.png
diff --git a/docs/sphinx/_static/img/OpenOffice_open.png → docs/source/_static/img/OpenOffice_open.png b/docs/sphinx/_static/img/OpenOffice_open.png → docs/source/_static/img/OpenOffice_open.png
diff --git a/docs/sphinx/_templates/autosummary/base.rst → docs/source/_templates/autosummary/base.rst b/docs/sphinx/_templates/autosummary/base.rst → docs/source/_templates/autosummary/base.rst
diff --git a/docs/sphinx/_templates/autosummary/class.rst → docs/source/_templates/autosummary/class.rst b/docs/sphinx/_templates/autosummary/class.rst → docs/source/_templates/autosummary/class.rst
diff --git a/...hinx/_templates/autosummary/class.rst.bak → ...urce/_templates/autosummary/class.rst.bak b/...hinx/_templates/autosummary/class.rst.bak → ...urce/_templates/autosummary/class.rst.bak
diff --git a/.../sphinx/_templates/autosummary/module.rst → .../source/_templates/autosummary/module.rst b/.../sphinx/_templates/autosummary/module.rst → .../source/_templates/autosummary/module.rst
diff --git a/docs/sphinx/addons-clouddav.rst → docs/source/addons-clouddav.rst b/docs/sphinx/addons-clouddav.rst → docs/source/addons-clouddav.rst
diff --git a/docs/sphinx/addons-couch-propman.rst → docs/source/addons-couch-propman.rst b/docs/sphinx/addons-couch-propman.rst → docs/source/addons-couch-propman.rst
diff --git a/docs/sphinx/addons-mercurial.rst → docs/source/addons-mercurial.rst b/docs/sphinx/addons-mercurial.rst → docs/source/addons-mercurial.rst
diff --git a/docs/sphinx/addons-mongo-propman.rst → docs/source/addons-mongo-propman.rst b/docs/sphinx/addons-mongo-propman.rst → docs/source/addons-mongo-propman.rst
diff --git a/docs/sphinx/addons-mongo.rst → docs/source/addons-mongo.rst b/docs/sphinx/addons-mongo.rst → docs/source/addons-mongo.rst
diff --git a/docs/sphinx/addons-mysql.rst → docs/source/addons-mysql.rst b/docs/sphinx/addons-mysql.rst → docs/source/addons-mysql.rst
diff --git a/docs/sphinx/addons-ntdc.rst → docs/source/addons-ntdc.rst b/docs/sphinx/addons-ntdc.rst → docs/source/addons-ntdc.rst
diff --git a/docs/sphinx/addons-virtual.rst → docs/source/addons-virtual.rst b/docs/sphinx/addons-virtual.rst → docs/source/addons-virtual.rst
diff --git a/docs/sphinx/api-doc.rst → docs/source/api-doc.rst b/docs/sphinx/api-doc.rst → docs/source/api-doc.rst
diff --git a/docs/changelog04.md → docs/source/changelog04.md b/docs/changelog04.md → docs/source/changelog04.md
diff --git a/docs/sphinx/changes.rst → docs/source/changes.rst b/docs/sphinx/changes.rst → docs/source/changes.rst
diff --git a/docs/client_status.odt → docs/source/client_status.odt b/docs/client_status.odt → docs/source/client_status.odt
diff --git a/docs/sphinx/conf.py → docs/source/conf copy.py b/docs/sphinx/conf.py → docs/source/conf copy.py
@@ -105,6 +105,7 @@
 # The full version, including alpha/beta/rc tags.
 #release = '1.0'
 import pkg_resources
+
 try:
     release = pkg_resources.get_distribution('wsgidav').version
 except pkg_resources.DistributionNotFound:
@@ -118,6 +119,7 @@
     for fn in os.listdir(package_root):
         print("-", fn)
     sys.exit(1)
+
 del pkg_resources
 
 version = '.'.join(release.split('.')[:2])