ReadTheDocs fix attempt No. 2

[ocket8888]

I checked my site packages and in version 5.1 Sphinx is correctly importing Union from the typing package, not the types package, so I figure it's worth a shot updating our dependencies to see if that fixes the RTD build.

I also fixed a bunch of docs problems I encountered when checking that the build works with my versions of things. And also during those fixes I noticed an endpoint in the Python client is being offered at version 5.x but it doesn't actually exist in APIv5.

---

Which Traffic Control components are affected by this PR?

• Documentation
• Traffic Control Client (Python)

What is the best way to verify this PR?

Build the docs, check that there are no errors or warnings. Other than that, we'll need to wait for RTD to pick it up to verify that it helps with that.

If this is a bugfix, which Traffic Control versions contained the bug?

• unknown

PR submission checklist

• This PR uses existing tests
• This PR is documentation
• This PR doesn't need a CHANGELOG.md entry
• This PR DOES NOT FIX A SERIOUS SECURITY VULNERABILITY

[zrhoffman]

It's failing to install dependencies:

[...]
Collecting sphinxcontrib-jquery<5,>=4 (from sphinx-rtd-theme>=1.3->-r docs/source/requirements.txt (line 16))
  Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl (121 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 121.1/121.1 kB 278.2 MB/s eta 0:00:00
INFO: pip is looking at multiple versions of sphinx-autodoc-typehints to determine which version is compatible with other requirements. This could take a while.
ERROR: Cannot install -r docs/source/requirements.txt (line 16), -r docs/source/requirements.txt (line 17) and Sphinx<5.2 and >=5.1 because these package versions have conflicting dependencies.

The conflict is caused by:
    The user requested Sphinx<5.2 and >=5.1
    sphinx-rtd-theme 1.3.0 depends on sphinx<8 and >=1.6
    sphinx-autodoc-typehints 1.24.0 depends on sphinx>=7.0.1

To fix this you could try to:
1. loosen the range of package versions you've specified
2. remove package versions to allow pip attempt to solve the dependency conflict

ERROR: ResolutionImpossible: for help visit https://pip.pypa.io/en/latest/topics/dependency-resolution/#dealing-with-dependency-conflicts 

Full log (click to expand)

$ python -m pip install --exists-action=w --no-cache-dir -r docs/source/requirements.txt
Collecting Sphinx<5.2,>=5.1 (from -r docs/source/requirements.txt (line 15))
  Downloading Sphinx-5.1.1-py3-none-any.whl (3.2 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.2/3.2 MB 40.5 MB/s eta 0:00:00
Collecting sphinx-rtd-theme>=1.3 (from -r docs/source/requirements.txt (line 16))
  Obtaining dependency information for sphinx-rtd-theme>=1.3 from https://files.pythonhosted.org/packages/18/01/76f40a18e9209bb098c1c1313c823dbbd001b23a2db71e7fd4eb5a48559c/sphinx_rtd_theme-1.3.0-py2.py3-none-any.whl.metadata
  Downloading sphinx_rtd_theme-1.3.0-py2.py3-none-any.whl.metadata (4.5 kB)
Collecting sphinx_autodoc_typehints>=1.24 (from -r docs/source/requirements.txt (line 17))
  Obtaining dependency information for sphinx_autodoc_typehints>=1.24 from https://files.pythonhosted.org/packages/a4/a2/71ee28033c218b025348555747cb95993338179875bae75c197138be77ad/sphinx_autodoc_typehints-1.24.0-py3-none-any.whl.metadata
  Downloading sphinx_autodoc_typehints-1.24.0-py3-none-any.whl.metadata (7.8 kB)
Requirement already satisfied: Pygments>=2.6 in /home/docs/checkouts/readthedocs.org/user_builds/traffic-control-cdn/envs/latest/lib/python3.11/site-packages (from -r docs/source/requirements.txt (line 18)) (2.16.1)
Collecting munch>=2.1.1 (from -r docs/source/requirements.txt (line 19))
  Obtaining dependency information for munch>=2.1.1 from https://files.pythonhosted.org/packages/56/b3/7c69b37f03260a061883bec0e7b05be7117c1b1c85f5212c72c8c2bc3c8c/munch-4.0.0-py2.py3-none-any.whl.metadata
  Downloading munch-4.0.0-py2.py3-none-any.whl.metadata (5.9 kB)
Collecting future>=0.16.0 (from -r docs/source/requirements.txt (line 20))
  Downloading future-0.18.3.tar.gz (840 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 840.9/840.9 kB 237.2 MB/s eta 0:00:00
  Preparing metadata (setup.py): started
  Preparing metadata (setup.py): finished with status 'done'
Collecting distro (from -r docs/source/requirements.txt (line 21))
  Downloading distro-1.8.0-py3-none-any.whl (20 kB)
Collecting sphinxcontrib-applehelp (from Sphinx<5.2,>=5.1->-r docs/source/requirements.txt (line 15))
  Obtaining dependency information for sphinxcontrib-applehelp from https://files.pythonhosted.org/packages/c0/0c/261c0949083c0ac635853528bb0070c89e927841d4e533ba0b5563365c06/sphinxcontrib_applehelp-1.0.7-py3-none-any.whl.metadata
  Downloading sphinxcontrib_applehelp-1.0.7-py3-none-any.whl.metadata (2.2 kB)
Collecting sphinxcontrib-devhelp (from Sphinx<5.2,>=5.1->-r docs/source/requirements.txt (line 15))
  Obtaining dependency information for sphinxcontrib-devhelp from https://files.pythonhosted.org/packages/c0/03/010ac733ec7b7f71c1dc88e7115743ee466560d6d85373b56fb9916e4586/sphinxcontrib_devhelp-1.0.5-py3-none-any.whl.metadata
  Downloading sphinxcontrib_devhelp-1.0.5-py3-none-any.whl.metadata (2.2 kB)
Collecting sphinxcontrib-jsmath (from Sphinx<5.2,>=5.1->-r docs/source/requirements.txt (line 15))
  Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB)
Collecting sphinxcontrib-htmlhelp>=2.0.0 (from Sphinx<5.2,>=5.1->-r docs/source/requirements.txt (line 15))
  Obtaining dependency information for sphinxcontrib-htmlhelp>=2.0.0 from https://files.pythonhosted.org/packages/28/7a/958f8e3e6abe8219d0d1f1224886de847ab227b218f4a07b61bc337f64be/sphinxcontrib_htmlhelp-2.0.4-py3-none-any.whl.metadata
  Downloading sphinxcontrib_htmlhelp-2.0.4-py3-none-any.whl.metadata (2.2 kB)
Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.5 in /home/docs/checkouts/readthedocs.org/user_builds/traffic-control-cdn/envs/latest/lib/python3.11/site-packages (from Sphinx<5.2,>=5.1->-r docs/source/requirements.txt (line 15)) (1.1.5)
Collecting sphinxcontrib-qthelp (from Sphinx<5.2,>=5.1->-r docs/source/requirements.txt (line 15))
  Obtaining dependency information for sphinxcontrib-qthelp from https://files.pythonhosted.org/packages/1f/e5/1850f3f118e95581c1e30b57028ac979badee1eb29e70ee72b0241f5a185/sphinxcontrib_qthelp-1.0.6-py3-none-any.whl.metadata
  Downloading sphinxcontrib_qthelp-1.0.6-py3-none-any.whl.metadata (2.2 kB)
Requirement already satisfied: Jinja2>=2.3 in /home/docs/checkouts/readthedocs.org/user_builds/traffic-control-cdn/envs/latest/lib/python3.11/site-packages (from Sphinx<5.2,>=5.1->-r docs/source/requirements.txt (line 15)) (3.0.3)
Requirement already satisfied: docutils<0.20,>=0.14 in /home/docs/checkouts/readthedocs.org/user_builds/traffic-control-cdn/envs/latest/lib/python3.11/site-packages (from Sphinx<5.2,>=5.1->-r docs/source/requirements.txt (line 15)) (0.17.1)
Requirement already satisfied: snowballstemmer>=1.1 in /home/docs/checkouts/readthedocs.org/user_builds/traffic-control-cdn/envs/latest/lib/python3.11/site-packages (from Sphinx<5.2,>=5.1->-r docs/source/requirements.txt (line 15)) (2.2.0)
Requirement already satisfied: babel>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/traffic-control-cdn/envs/latest/lib/python3.11/site-packages (from Sphinx<5.2,>=5.1->-r docs/source/requirements.txt (line 15)) (2.12.1)
Requirement already satisfied: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/traffic-control-cdn/envs/latest/lib/python3.11/site-packages (from Sphinx<5.2,>=5.1->-r docs/source/requirements.txt (line 15)) (0.7.13)
Requirement already satisfied: imagesize in /home/docs/checkouts/readthedocs.org/user_builds/traffic-control-cdn/envs/latest/lib/python3.11/site-packages (from Sphinx<5.2,>=5.1->-r docs/source/requirements.txt (line 15)) (1.4.1)
Requirement already satisfied: requests>=2.5.0 in /home/docs/checkouts/readthedocs.org/user_builds/traffic-control-cdn/envs/latest/lib/python3.11/site-packages (from Sphinx<5.2,>=5.1->-r docs/source/requirements.txt (line 15)) (2.31.0)
Requirement already satisfied: packaging in /home/docs/checkouts/readthedocs.org/user_builds/traffic-control-cdn/envs/latest/lib/python3.11/site-packages (from Sphinx<5.2,>=5.1->-r docs/source/requirements.txt (line 15)) (23.1)
Collecting sphinxcontrib-jquery<5,>=4 (from sphinx-rtd-theme>=1.3->-r docs/source/requirements.txt (line 16))
  Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl (121 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 121.1/121.1 kB 278.2 MB/s eta 0:00:00
INFO: pip is looking at multiple versions of sphinx-autodoc-typehints to determine which version is compatible with other requirements. This could take a while.
ERROR: Cannot install -r docs/source/requirements.txt (line 16), -r docs/source/requirements.txt (line 17) and Sphinx<5.2 and >=5.1 because these package versions have conflicting dependencies.

The conflict is caused by:
    The user requested Sphinx<5.2 and >=5.1
    sphinx-rtd-theme 1.3.0 depends on sphinx<8 and >=1.6
    sphinx-autodoc-typehints 1.24.0 depends on sphinx>=7.0.1

To fix this you could try to:
1. loosen the range of package versions you've specified
2. remove package versions to allow pip attempt to solve the dependency conflict

ERROR: ResolutionImpossible: for help visit https://pip.pypa.io/en/latest/topics/dependency-resolution/#dealing-with-dependency-conflicts 

[ocket8888]

Yeah, I noticed that - it's odd because I literally just used the versions I have and everything seemed to work fine locally. I'll try again.