Update config and dependencies for docs (#60)

* Add Read the Docs build file

* Update docs requirements and add Read the Docs config

.readthedocs.yaml

@@ -0,0 +1,9 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+sphinx:
+  configuration: docs/conf.py

Makefile

@@ -41,7 +41,7 @@ coverage:
 docs:
 	rm -f docs/geocodio.rst
 	rm -f docs/modules.rst
-	sphinx-apidoc -o docs/ geocodio
+	sphinx-apidoc -o docs/ src/geocodio
 	$(MAKE) -C docs clean
 	$(MAKE) -C docs html
 	open docs/_build/html/index.html

dev-requirements.txt

@@ -1,4 +1,3 @@
-Sphinx==1.2.1
 coverage==3.7.1
 twine>=1.6.5
 wheel>=0.29.0

docs/conf.py

@@ -40,8 +40,8 @@
 master_doc = "index"
 
 # General information about the project.
-project = u"pygeocodio"
-copyright = u"2014-2023, Ben Lopatin and contributors"
+project = "pygeocodio"
+copyright = "2014-2023, Ben Lopatin and contributors"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -191,7 +191,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    ("index", "pygeocodio.tex", u"pygeocodio Documentation", u"Ben Lopatin", "manual")
+    ("index", "pygeocodio.tex", "pygeocodio Documentation", "Ben Lopatin", "manual")
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -219,7 +219,7 @@
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [("index", "pygeocodio", u"pygeocodio Documentation", [u"Ben Lopatin"], 1)]
+man_pages = [("index", "pygeocodio", "pygeocodio Documentation", ["Ben Lopatin"], 1)]
 
 # If true, show URL addresses after external links.
 # man_show_urls = False
@@ -234,8 +234,8 @@
     (
         "index",
         "pygeocodio",
-        u"pygeocodio Documentation",
-        u"Ben Lopatin",
+        "pygeocodio Documentation",
+        "Ben Lopatin",
         "pygeocodio",
         "One line description of project.",
         "Miscellaneous",

docs/geocodio.rst

@@ -8,31 +8,30 @@ geocodio.client module
 ----------------------
 
 .. automodule:: geocodio.client
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 geocodio.data module
 --------------------
 
 .. automodule:: geocodio.data
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 geocodio.exceptions module
 --------------------------
 
 .. automodule:: geocodio.exceptions
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 Module contents
 ---------------
 
 .. automodule:: geocodio
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

requirements-docs.txt

@@ -0,0 +1 @@
+Sphinx==7.0.1