Configure Read The Docs (#251)

* Add a ReadTheDocs config file

* Make the link unnamed

* Drop the duplicate module entry in Sphinx docs

* Stop referring to a non-existent static dir in doc

Author: webknjaz

.readthedocs.yaml

@@ -0,0 +1,28 @@
+---
+
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html
+# for details
+
+version: 2
+
+sphinx:
+  builder: dirhtml
+  configuration: docs/conf.py
+  fail_on_warning: true
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: >-
+      3.11
+
+python:
+  install:
+  - method: pip
+    path: .
+  - requirements: docs/requirements.txt
+  system_packages: false
+
+...

docs/api.rst

@@ -35,8 +35,6 @@ TOML File
 TOML Items
 ----------
 
-.. module:: tomlkit.items
-
 .. automodule:: tomlkit.items
    :show-inheritance:
    :members:

docs/conf.py

@@ -57,4 +57,4 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
+html_static_path = []

tomlkit/api.py

@@ -119,7 +119,7 @@ def string(
     boolean flags (e.g. ``literal=True`` and/or ``multiline=True``)
     can be used for personalization.
 
-    For more information, please check the spec: `https://toml.io/en/v1.0.0#string`_.
+    For more information, please check the spec: `<https://toml.io/en/v1.0.0#string>`__.
 
     Common escaping rules will be applied for basic strings.
     This can be controlled by explicitly setting ``escape=False``.