[CIVIS-8476] DOC configure "readthedocs" builds and refresh docs

civisanalytics / civis-python

Civis API Python Client

BSD 3-Clause "New" or "Revised" License

34 stars 26 forks source link

[CIVIS-8476] DOC configure "readthedocs" builds and refresh docs #483

Closed jacksonlee-civis closed 5 months ago

jacksonlee-civis commented 5 months ago

This pull request configures the "readthedocs" doc builds by adding .readthedocs.yaml. Also added a requirements file to pin all transitive dependencies for doc builds, as well as refreshed all the docs in general.

[x] (For Civis employees only) Reference to a relevant ticket in the pull request title
[x] Changelog entry added to CHANGELOG.md at the repo's root level
[x] Description of change in the pull request description
[x] If applicable, unit tests have been added and/or updated
[x] The CircleCI builds have all passed

jacksonlee-civis commented 5 months ago

~Needed to actually create a pull request to test/update the "readthedocs" doc builds. This PR is not ready for review yet. If you're watching this PR, expect noisy commits as I iterate (note that you can unsubscribe from this PR).~

~Looks like we might need a .readthedocs.yaml already sitting at the repo root on the main branch to trigger the doc builds. So we'll try to get this config file in first, and then future pull requests will update it and the rest of the documentation.~

jacksonlee-civis commented 5 months ago

@Drew-Pappas I went back and forth about these doc updates, but apparently the readthedocs builds have actually kicked in for PR branches. For this PR, see https://civis-python--483.org.readthedocs.build/en/483/ -- let me know if you don't like anything that I can fix before making the v2.0.0 release!