Add initial sphinx docs. (#69)

.github/workflows/python-package.yml

@@ -39,6 +39,11 @@ jobs:
       run: |
         flake8 . --count --select=E9,F63,F7,F82 --show-source
         flake8 . --count --exit-zero --max-complexity=10
+    - name: Documentation
+      run: |
+        python -m pip install sphinx
+        pushd docs && make html && popd
+      if: success() && matrix.platform == 'ubuntu-latest' && matrix.lc-all == 'en_US.utf-8' && matrix.python-version == '3.9'
     - name: Test with pytest (Ubuntu)
       run: |
         LC_ALL=${{ matrix.lc-all}} python -c "import sys; print(sys.getfilesystemencoding())"

MANIFEST.in

@@ -1,6 +1,7 @@
 include *.py
 recursive-include pathlib2 *.py
 recursive-include tests *.py
+recursive-include docs *
 include *.rst
 include VERSION
 include requirements.txt

README.rst

@@ -5,8 +5,8 @@ pathlib2
 
 Fork of pathlib aiming to support the full stdlib Python API.
 
-The `old pathlib <https://bitbucket.org/pitrou/pathlib>`_
-module on bitbucket is in bugfix-only mode.
+The `old pathlib <https://web.archive.org/web/20181106215056/https://bitbucket.org/pitrou/pathlib/>`_
+module on bitbucket is no longer maintained.
 The goal of pathlib2 is to provide a backport of
 `standard pathlib <http://docs.python.org/dev/library/pathlib.html>`_
 module which tracks the standard library module,

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     = .
+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)

docs/conf.py

@@ -0,0 +1,14 @@
+# Configuration file for the Sphinx documentation builder.
+
+project = 'pathlib2'
+copyright = '2012-2014 Antoine Pitrou and contributors; 2014-2021, Matthias C. M. Troffaes and contributors'
+author = 'Matthias C. M. Troffaes'
+
+# The full version, including alpha/beta/rc tags
+with open("../VERSION", "r") as version_file:
+    release = version_file.read().strip()
+
+# -- General configuration ---------------------------------------------------
+
+extensions = []
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

docs/index.rst

@@ -0,0 +1,8 @@
+Welcome to pathlib2's documentation!
+====================================
+
+:Release: |release|
+:Date:    |today|
+
+.. include:: ../README.rst
+   :start-line: 6

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=.
+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

pathlib2/__init__.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2014-2021 Matthias C. M. Troffaes
+# Copyright (c) 2014-2021 Matthias C. M. Troffaes and contributors
 # Copyright (c) 2012-2014 Antoine Pitrou and contributors
 # Distributed under the terms of the MIT License.