Fixing read the docs error with markup language in argsparser#197
Fixing read the docs error with markup language in argsparser#197
Conversation
Bento007
commented
Sep 28, 2018
- 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.
| @@ -0,0 +1,6 @@ | |||
| .wy-table-responsive table td { | |||
| white-space: normal !important; | |||
There was a problem hiding this comment.
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
There was a problem hiding this comment.
I'm not really css fluent. If you know better please correct me.
Codecov Report
@@ Coverage Diff @@
## master #197 +/- ##
=======================================
Coverage 83.53% 83.53%
=======================================
Files 37 37
Lines 1464 1464
=======================================
Hits 1223 1223
Misses 241 241Continue to review full report at Codecov.
|
|
Does this also resolve #179? |
|
@kozbo no this is an unrelated issues cause by updates to the dss. |
xbrianh
left a comment
There was a problem hiding this comment.
lgtm, but that doesn't mean much.
@calvinnhieu revisit?