Improve documentation links and enforce compliant syntax

[bmos]

What is this change?

CI

• Add (non-failing) linkcheck job to display broken links in documentation (doesn't run on PRs)
• Allow makefile to pass command-line args to make targets
• Add make target test which finds syntax and link issues in latest sphinx documentation (runs before build-multiversion)
• Improve debug logging in makefile
• Maintain github actions cache for documentation builds across more runs

Sphinx Configuration

• Auto-linking to external sphinx documentation
• Auto-creating of heading reference targets
• Fix all sphinx syntax issues (errors and warnings)

Documentation / Docstring Updates

• Better use of code blocks
• Consistent heading syntax in ReST files: (#, * (as needed) , =, -, ^, ')
• Split aws documentation into subfiles with dropdown in index.
• Split google documentation into subfiles with dropdown in index.
• Split databases documentation into subfiles with dropdown in index.
• Split notifications documentation into subfiles with dropdown in index.
• Move framework index section to folder
• Replace many ReST note blocks with admonitions (which can have titles)

Other

• Cherry-picked Blacklist broken mysql-connector-python v9.7.0 #1854 to get CI working.

Considerations for discussion

• (List out any significant design decisions that were made and why.)

How to test the changes (if needed)

• CI tests are adequate

Breaking Changes

Breaking changes are changes to our public API which may require existing users to change their code. If there are no breaking changes, any existing parsons user should not need to do anything after updating their parsons version.

Does this PR introduce breaking changes?

• label: Breaking change — This PR introduces one or more breaking changes.
• label: Non-breaking change — This PR does not introduce one or more breaking changes.

Details (if needed)

• (List out any changes to the API that may cause breaks for developer implementation.)

[ghost]

Coverage report

Click to see where and how coverage changed

File	Statements	Missing	Coverage	Coverage (new stmts)	Lines missing
parsons/action_builder
action_builder.py					156-157
parsons/action_kit
action_kit.py					430-431, 458-459, 558-559, 617-618, 673-674, 732-733, 837-839, 1172-1173, 1324
parsons/aws
s3.py					98, 112, 160-161, 238-240, 271, 292, 305, 330-331, 353, 405-406, 458-459
parsons/azure
azure_blob_storage.py					77-79, 92-94, 112-113, 142, 157-158, 175-177, 193-195, 215-217, 254-256, 285-287, 326, 361-362, 384-386, 409-411
parsons/copper
copper.py
parsons/databases
table.py					50-52, 81, 127-129, 136-137
parsons/databases/redshift
rs_table_utilities.py					79-80, 98-100, 164-165, 257-258, 293-294, 321-323, 351-353, 395, 461-462, 487, 543, 625-627, 653-655, 701-703, 729-731
parsons/empower
empower.py					57, 226, 249-250
parsons/etl
etl.py					915, 936
table.py					135, 197, 281
tofrom.py					227, 375, 492-494, 562-564, 641-643, 698-700, 733-735, 764-767, 820-822, 975-977, 998-1000, 1034-1036
parsons/geocode
census_geocoder.py					51-53, 84-86, 112-114, 139, 150-152
parsons/github
github.py					134, 148, 180-182, 202-204, 224, 308, 344-346, 372-374, 459
parsons/google
google_bigquery.py					105-106, 329, 869-870, 1167-1170, 1289-1291, 1309-1310, 1338, 1373-1375, 1748-1749, 1810, 1814
google_cloud_storage.py					96-98, 111-113, 148, 163-165, 197, 220-222, 258-259, 285-286, 395-397, 622, 663-665, 678-680
google_sheets.py					98-100, 120-122, 158-159, 182-184, 208-210, 276-278, 336-338, 390-391, 471-473
parsons/hustle
hustle.py					348, 592-594, 614-616
parsons/ngpvan
bulk_import.py					115-117
people.py					164, 201, 262, 307, 585
saved_lists.py					65-66
supporter_groups.py					58-60
parsons/scytl
scytl.py
parsons/sftp
sftp.py					78-80, 109-110, 126-127, 143-144, 179-180, 229-231, 279-280, 337-338, 390-391, 411-412, 519-520
parsons/utilities
api_connector.py					264
parsons/zoom
zoom.py					191, 241, 263-265, 670-672, 724-726, 740-742, 773, 802-803, 827-829, 852-854, 875-877, 901-903, 926-928, 949-951, 972-974, 995-997
Project Total

The report is truncated to 25 files out of 97. To see the full report, please visit the workflow summary page.

This report was generated by python-coverage-comment-action