search

rapidsai / deployment

RAPIDS Deployment Documentation
https://docs.rapids.ai/deployment/stable/
9 stars 28 forks source link

[DOC] fix code blocks in md files to correctly identify code for copying #283

Open taureandyernv opened 1 year ago

taureandyernv commented 1 year ago

In several documents pages, such as https://docs.rapids.ai/deployment/nightly/cloud/aws/eks/, the conversion from markdown to sphinx docs breaks the multiline copy function in the console code block. When the user attempts to copy the code command from the block using the button or parsing the markdown, they only get the first line of the command instead of the complete multiline command. This does not happen in the Github previews

Example from https://docs.rapids.ai/deployment/nightly/cloud/aws/eks/:

Github preview copy command results: 

$ eksctl create cluster rapids \
`                      --version 1.24 \
                      --nodes 3 \
                      --node-type=p3.8xlarge \
                      --timeout=40m \
                      --ssh-access \
                      --ssh-public-key <public key ID> \  # Be sure to set your public key ID here
                      --region us-east-1 \
                      --zones=us-east-1c,us-east-1b,us-east-1d \
                      --auto-kubeconfig \
                      --install-nvidia-plugin=false

Deployments EKS webpage copy command results

eksctl create cluster rapids \