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

Cleaned up format warnings when building sphinx-guides [ref #6997] #6998

Merged
merged 5 commits into from Jul 1, 2020

Conversation

mheppler
Copy link
Contributor

What this PR does / why we need it:

14 warnings when building sphinxx-guides.

Which issue(s) this PR closes:

Closes #6997 WARNING: Misc sphinx-guides formatting clean up

Special notes for your reviewer:

When building the sphinx-guides, you should see no warnings.

Suggestions on how to test this:

Build the guides, enjoy the silence.

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

It fixes the display of links.

Is there a release notes update needed for this change?:

N/A

Additional documentation:

Sphinx formatting documentation reference for further details: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html

@coveralls
Copy link

coveralls commented Jun 17, 2020

Coverage Status

Coverage remained the same at 19.647% when pulling 7492e77 on 6997-guides-clean-up into 6bc6795 on develop.

@pdurbin
Copy link
Member

pdurbin commented Jun 22, 2020

I built the docs and noticed this error...

/Users/pdurbin/github/iqss/dataverse/doc/sphinx-guides/source/developers/deployment.rst:89: WARNING: download file not readable: /Users/pdurbin/github/iqss/dataverse/doc/sphinx-guides/source/developers/https:/raw.githubusercontent.com/IQSS/dataverse-ansible/master/ec2/ec2-create-instance.sh

... and fixed it with c3b5982

@pdurbin pdurbin removed their assignment Jun 22, 2020
Copy link
Member

@pdurbin pdurbin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I fixed one more warning and fix some formatting in the installation guide.

IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) automation moved this from Code Review 🦁 to QA 🔎✅ Jun 22, 2020
@kcondon kcondon self-assigned this Jul 1, 2020
@kcondon kcondon merged commit 4eda5a1 into develop Jul 1, 2020
IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) automation moved this from QA 🔎✅ to Done 🚀 Jul 1, 2020
@kcondon kcondon deleted the 6997-guides-clean-up branch July 1, 2020 19:11
@djbrooke djbrooke added this to the Dataverse 5 milestone Jul 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

WARNING: Misc sphinx-guides formatting clean up
5 participants