Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docs with underscore postfix for hyperlink? #1979

Merged
merged 1 commit into from
Jan 24, 2022

Conversation

jeroenhe
Copy link
Contributor

@jeroenhe jeroenhe commented Jan 24, 2022

Hopefully fixes #1978

I'm sorry this seems to be ending up in a "trial-and-error". I just don't know how to quickly verify changes to .rst files locally.

@cyberw
Copy link
Collaborator

cyberw commented Jan 24, 2022

@jeroenhe
Copy link
Contributor Author

Have a look at http://docs.locust.io/en/stable/developing-locust.html#build-documentation

Thank you. It was actually fairly easy to build the documentation locally. The previous links with :ref: did cause these warnings in the documentation build log output:

Users/jeroen/Src/locust/docs/running-cloud-integration.rst:25: WARNING: undefined label: https://github.com/locustio/locust/blob/master/examples/terraform/aws/readme.md
/Users/jeroen/Src/locust/docs/running-cloud-integration.rst:27: WARNING: undefined label: https://learn.hashicorp.com/tutorials/terraform/install-cli?in=terraform/aws-get-started#install-terraform-on-linux
/Users/jeroen/Src/locust/docs/running-cloud-integration.rst:29: WARNING: undefined label: https://registry.terraform.io/modules/marcosborges/loadtest-distribuited/aws/latest

I can confirm that this PR fixes the links. These warnings are now gone and the links actually works:

Screenshot 2022-01-24 at 14 08 39

@cyberw cyberw merged commit 363d628 into locustio:master Jan 24, 2022
@cyberw
Copy link
Collaborator

cyberw commented Jan 24, 2022

Thx

@jeroenhe jeroenhe deleted the master-update-docs branch January 24, 2022 13:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants