diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..706d2d4 --- /dev/null +++ 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 index 8243ab3..0d2b5ab 100644 --- 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 `__. diff --git a/docs/index.rst b/docs/index.rst index f5b0c07..c0948b4 100644 --- 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 new file mode 100644 index 0000000..e69de29