Copy Documentation files to S3

[ajschmidt8]

We are in the process of updating the documentation-building process for RAPIDS libraries so that they upload their HTML files to S3.

In the future, S3 will be used as the "source of truth" for documentation instead of the https://github.com/rapidsai/docs/ repository. That repository will then be configured to pull the HTML files from S3 during build time.

In preparation for the removal of the HTML files from the rapidsai/docs repository, it would be helpful if the HTML files from this repository were also uploaded to S3.

Here are some additional links/comments that may be helpful:

• S3 location where the docs should be pushed (VERSION_NUMBER is like 23.04, 23.06, etc.): https://github.com/rapidsai/rmm/blob/ebf591ffc2fd7b83605f5725ec6e8ba425858c02/ci/build_docs.sh#L44
• We also made these sphinx adjustments in order to:
  • generate text docs in addition to HTML docs (this will help Taurean's efforts to create a diff tool that will help end-users identify API changes between releases)
  • switch from using sphinx's html builder to its dirhtml builder. This will generate URL paths that do not include extraneous .html extensions (see sphinx docs for more details).

[ajschmidt8]

A quick note about the dirhtml changes.

Switching from the html builder to the dirhtml builder on version 0.12 of the pydata-sphinx-theme will result in some unwanted styling changes for HTML tables.

This is a bug in their theme that is resolved in this PR, which should be released very soon (see 1,2).

For the other RAPIDS libs, this isn't much of an issue because the Jenkins-based doc building jobs that commit HTML files directly to the rapidsai/docs repository still use the html builder.

It's only the new GH Actions based docs build jobs that use the dirhtml builder and upload to S3.

I anticipate that by the time we're ready to use the S3 doc files, the new pydata-sphinx-theme will have been released and therefore this will not be an issue.

[ajschmidt8]

It looks like this task may just require editing the existing GHAs workflow below to push to S3 instead of the rapidsai/docs repository.

• deployment/.github/workflows/build-and-deploy.yml

  Lines 37 to 49 in 82f7b03

  	# If on main in the upstream repo then push to docs repo
  	- name: Pushes build files
  	uses: cpina/github-action-push-to-another-repository@v1.5.1
  	if: ${{ github.repository == 'rapidsai/deployment' && github.event_name == 'push' }}
  	env:
  	API_TOKEN_GITHUB: ${{ secrets.WORKFLOW_TOKEN }}
  	with:
  	source-directory: "build/html"
  	target-directory: ${{ startsWith(github.event.ref, 'refs/tags/') && 'deployment/stable' || 'deployment/nightly' }}
  	destination-github-username: "rapidsai"
  	destination-repository-name: "docs"
  	user-email: 1898282+github-actions[bot]@users.noreply.github.com
  	target-branch: gh-pages

[ajschmidt8]

PR: #214