tree 30b103641fb707fcca539138b6706e189827a506
parent 116a030c8d0ab2399d5871c8566f4b08c1637496
author Nick Vatamaniuc <vatamane@gmail.com> 1663022271 -0400
committer Nick Vatamaniuc <vatamane@apache.org> 1663044873 -0400
gpgsig -----BEGIN PGP SIGNATURE-----
 
 iQIzBAABCgAdFiEEC9ephJnEq0HJEO5l/ATfvJZXp44FAmMgDRMACgkQ/ATfvJZX
 p44awg/+Ja4zxP+isTljuHuwlx0reTl96LW9Ne9b8laGpx1m8/vHh5s8Ovm5Ktp4
 RxoZwUYSrRaQtyAPjEmAMXiC3eWzq2cYO5m8Qk+nd/0jfht6Fr71qmxNNKItWQ7/
 9rfrSvSM8hZxGpkaiSvVzXxVAQkep4RYKITEflbH7QkO9PFfEU67dj1zQIe5dBU1
 0t5c/bLEJ/zHpXKwgAEhhQVZ5/Kj1NOyWa/C6D12C6HIdl1euPvjAZ0x8txBACaF
 4/JQfzYLUAimBdCvBEVce5j1iQjZE7jrTi+YJWekD8RfAkuYKYxkikRUT3ertQHr
 lyKBOWJw1BPaYoTiARdNV8jw/mooikAvdz7ZzXx1E42HTG1gJZrvrHErqzVFi2P3
 AdPjc5+tcjT9V2EexnBxCmfm7Hc7xsCchk+B5txC/srcTMb7iSYuUKbS5erabREG
 XK6B2b5qMizChbfFhE4RL0L1Y29BFIuw/KT8PvUkc+T+B0Thz3CLfpT3o1lr+YhS
 vkRBMS67QlHsgDWT0RVEwsqMLYPRi8OMQNB51JFrDRpOD5YbtbhtaX/8z+fZwdq4
 NLfMk7PCXtpmn5kTaFrr/N3pk3YXRunwckJ9r76WgdOkHFjS/ytloJ9P/qanWY5C
 ZciRtaxL6UAP/NMfEhdhLFGrwQI88tGCx47Bb7R9y6s1k+PQYBc=
 =ck/n
 -----END PGP SIGNATURE-----

Upgrade to latest Sphinx 5.1.1 and fix the top Edit on Github link

"Edit on Github" link wasn't working and pointing to a non-existent "index"
file. This was most likely because we override the index.html template, so the
source renderer doesn't know what to link it to. Instead opt to make the top
level "Edit on Github" point the docs readme page. Individual doc pages will
point to their respective source pages.

In addition, we were quite a bit behind on on the sphinx version 1.5 vs 5.1.1
this has caused quite a bit of headaches over the years as we had to pin
jinja2, docutils and other libraries versions to avoid breaking things.

The main issue after the upgrade was that the http domain became a bit more
strict. After vendoring it in, we had to make a few multipart http examples use
plaintext. On the positive side, it found broken references in the admin guide,
so those were fixed. Since we're using the latest 5.1.1 opt to just use a
python3 venv with a short setup.sh script. That should make it easier for
contributors to build docs locally.