Skip to content

Fixing read the docs error with markup language in argsparser#197

Merged
Bento007 merged 2 commits intomasterfrom
tsmith-doc-fix
Oct 12, 2018
Merged

Fixing read the docs error with markup language in argsparser#197
Bento007 merged 2 commits intomasterfrom
tsmith-doc-fix

Conversation

@Bento007
Copy link
Copy Markdown
Collaborator

  • The swagger doc that is used to generate the cli argparser was failing to render using sphinx-argparse because of markdown in the parameter descriptions. This was fixed by telling sphinx-argparser to expect markups.
  • adding css for text wrapping long parameter descriptions in read the docs.

*  The swagger doc that is used to generate the cli argparser was failing to render using sphinx-argparse because of markdown in the parameter descriptions. This was fixed by telling sphinx-argparser to expect markups.
* adding css for text wrapping long parameter descriptions in read the docs.
@Bento007 Bento007 self-assigned this Sep 28, 2018
@@ -0,0 +1,6 @@
.wy-table-responsive table td {
white-space: normal !important;
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Is the !important required?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

honestly I don't know. I pulled it from the sphinx-argparse docs https://sphinx-argparse.readthedocs.io/en/stable/misc.html#text-wrapping-in-argument-tables

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I'm not really css fluent. If you know better please correct me.

@codecov-io
Copy link
Copy Markdown

codecov-io commented Sep 28, 2018

Codecov Report

Merging #197 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #197   +/-   ##
=======================================
  Coverage   83.53%   83.53%           
=======================================
  Files          37       37           
  Lines        1464     1464           
=======================================
  Hits         1223     1223           
  Misses        241      241

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e017ef6...58670c6. Read the comment docs.

@kozbo
Copy link
Copy Markdown
Collaborator

kozbo commented Sep 28, 2018

Does this also resolve #179?

@Bento007
Copy link
Copy Markdown
Collaborator Author

Bento007 commented Oct 1, 2018

@kozbo no this is an unrelated issues cause by updates to the dss.

@Bento007 Bento007 requested a review from xbrianh October 2, 2018 21:22
Copy link
Copy Markdown
Member

@xbrianh xbrianh left a comment

Choose a reason for hiding this comment

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

lgtm, but that doesn't mean much.

@calvinnhieu revisit?

@Bento007 Bento007 merged commit d801813 into master Oct 12, 2018
@Bento007 Bento007 deleted the tsmith-doc-fix branch October 12, 2018 18:38
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.

5 participants