Add an explicit config for building readthedocs

The explicit configuration is now required:
https://blog.readthedocs.com/migrate-configuration-v2/

Also rename the `README` file and link it from docs directory so
that the main page is actually generated.

Author: psss

.readthedocs.yaml

@@ -0,0 +1,6 @@
+# Config for building https://python-nitrate.readthedocs.io/
+version: 2
+build:
+    os: ubuntu-22.04
+    tools:
+        python: "3"

Makefile

@@ -13,7 +13,7 @@ PACKAGE = python-nitrate-$(VERSION)
 DOCS = $(TMP)/$(PACKAGE)/docs
 EXAMPLES = $(TMP)/$(PACKAGE)/examples
 CSS = --stylesheet=style.css --link-stylesheet
-FILES = LICENSE README \
+FILES = LICENSE README.rst \
 		Makefile python-nitrate.spec setup.py \
 		docs examples source
 
@@ -22,8 +22,8 @@ all: push clean
 build:
 	mkdir -p $(TMP)/{SOURCES,$(PACKAGE)}
 	cp -a $(FILES) $(TMP)/$(PACKAGE)
-	rst2man README | gzip > $(DOCS)/python-nitrate.1.gz
-	rst2html README $(CSS) > $(DOCS)/index.html
+	rst2man README.rst | gzip > $(DOCS)/python-nitrate.1.gz
+	rst2html README.rst $(CSS) > $(DOCS)/index.html
 	rst2man $(DOCS)/notes.rst | gzip > $(DOCS)/nitrate-notes.1.gz
 	rst2html $(DOCS)/notes.rst $(CSS) > $(DOCS)/notes.html
 	rst2man $(DOCS)/nitrate.rst | gzip > $(DOCS)/nitrate.1.gz

README README.rst

@@ -0,0 +1 @@
+../README.rst

docs/index.rst

@@ -122,7 +122,7 @@ pathfix.py -pni "%{__python3} %{py3_shbang_opts}i" %{buildroot}%{_bindir}/nitrat
 %{python3_sitelib}/nitrate-*.egg-info/
 %{_mandir}/man1/*
 %{_bindir}/nitrate
-%doc README examples
+%doc README.rst examples
 %license LICENSE
 
 %changelog

python-nitrate.spec

@@ -8,7 +8,7 @@
 
 # Prepare short and long description
 description = 'Python API for the Nitrate test case management system'
-with open("README") as readme:
+with open("README.rst") as readme:
     long_description = readme.read()
 
 # Parse version from the spec file