Configuration for Read the Docs (#10)

bbayles · web-flow · commit f2e4034bd054 · 2023-05-25T10:29:28.000-05:00
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,17 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+  jobs:
+    pre_install:
+      - make requirements
+      - make package
+      - python -m pip install -e .
+sphinx:
+   configuration: docs/conf.py
+
+python:
+   install:
+   - requirements: docs/requirements.txt
diff --git a/README.rst b/README.rst
@@ -74,3 +74,5 @@ It also provides some higher level functions for parsing and manipulating URLs.
     }
     >>> ada_url.replace_url('http://example.org:80', protocol='https:')
     'https://example.org/'
+
+You can find more documentation at `Read the Docs <https://ada-url.readthedocs.io>`__.
diff --git a/docs/index.rst b/docs/index.rst
@@ -50,11 +50,3 @@ API Documentation
 
 .. automodule:: ada_url
     :members:
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
diff --git a/docs/requirements.txt b/docs/requirements.txt

Original file line number	Diff line number	Diff line change
`@@ -74,3 +74,5 @@ It also provides some higher level functions for parsing and manipulating URLs.`
`74`	`74`	`}`
`75`	`75`	`>>> ada_url.replace_url('http://example.org:80', protocol='https:')`
`76`	`76`	`'https://example.org/'`
	`77`	`+`
	`78`	+You can find more documentation at `Read the Docs <https://ada-url.readthedocs.io>`__.