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

GUIDES REDUX: Misc sphinx-guides formatting clean up #7066

Closed
mheppler opened this issue Jul 8, 2020 · 1 comment · Fixed by #7071
Closed

GUIDES REDUX: Misc sphinx-guides formatting clean up #7066

mheppler opened this issue Jul 8, 2020 · 1 comment · Fixed by #7071

Comments

@mheppler
Copy link
Contributor

mheppler commented Jul 8, 2020

Despite my efforts in PR #6998 to resolve all formatting warning, in the past 7 days since those fixes were merged, we have another four warnings that managed to creep in the guides somehow.

/dataverse/doc/sphinx-guides/source/developers/deployment.rst:87: WARNING: Mismatch: both interpreted text role prefix and reference suffix.
/dataverse/doc/sphinx-guides/source/developers/testing.rst:140: WARNING: Unknown target name: "dataverse-ansible repo<https://github.com/globaldataversecommunityconsortium/dataverse-ansible/>".
/dataverse/doc/sphinx-guides/source/developers/testing.rst:142: WARNING: Unknown target name: "ec2-create-instance.sh<https://raw.githubusercontent.com/globaldataversecommunityconsortium/dataverse-ansible/master/ec2/ec2-create-instance.sh>".
/dataverse/doc/sphinx-guides/source/developers/testing.rst:143: WARNING: Unknown target name: "main.yml<https://raw.githubusercontent.com/globaldataversecommunityconsortium/dataverse-ansible/master/defaults/main.yml>".

Will provide a bulleted list of changes that resolved these warnings, as well as any other typos and formatting issues I stumble upon while in there.

@mheppler
Copy link
Contributor Author

mheppler commented Jul 8, 2020

WARNINGS

developers/deployment.rst

  • (line 87) "Mismatch: both interpreted text role prefix and reference suffix", needed to remove the :download: prefix from "group vars" link since it is not a local file, treating it as a normal link now @donsizemore 4e70dd6

developers/testing.rst

  • (line 140) "Unknown target name", needed space between "dataverse-ansible repo" link text and url bracket @donsizemore 4e70dd6
  • (line 142) "Unknown target name", needed space between "ec2-create-instance.sh" link text and url bracket @donsizemore 4e70dd6
  • (line 143) "Unknown target name", needed space between "main.yml" link text and url bracket @donsizemore 4e70dd6

OTHER MISC CLEAN UP

developers/deployment.rst

  • (line 112, 114, 122, 133) fixed formatting of file:// so it doesn't display as a clickable link @donsizemore a12fab6

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant