Closed
Description
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 like23.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
'shtml
builder to itsdirhtml
builder. This will generate URL paths that do not include extraneous.html
extensions (see sphinx docs for more details).
- generate text docs in addition to HTML docs (this will help Taurean's efforts to create a
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment