Opened 2 years ago

Closed 2 years ago

#1164 closed defect (fixed)

Sphinx doc build does not support superscript or substitution

Reported by: butler Owned by:
Priority: major Milestone: SasView 4.2.0
Component: SasView Keywords:
Cc: Work Package: SasView Framework Enhancements


While fixing a syntax issue with the superscript on slit_calculator_help.rst I discovered that even properly formatted superscripts such as:

xxx\ :sup:`a`

do not render. Moreover 1\|Ang| does not substitute |Ang| despite it being listed in sasview/docs/sphinx-docs/source/prolog.rst Further testing by including a replace directive in the same help.rst file did not work either. At least getting superscripts working would be nice.

Change History (4)

comment:1 Changed 2 years ago by smk78

In PR 168 @pkienzle said:

Fix the problem with sphinx superscript and substitution (Ticket 1164) in an emphasized environment by removing the emphasis.

Not the best solution. May want to try the most recent version of sphinx under python 3 to see if this problem has already been fixed upstream.

Other option is to turn off emphasis for the superscript and the substitution.

@butlerpd replied:

Need to check output yet but a couple of comments:

If Prolog.rst is not used perhaps we should remove.

Removing the emphasis should be fine but since it already says "Note!" maybe making it a note . i.e.
:: Note: xyz would be appropriate?

@butlerpd then added:

Reading this again I don't believe using the NOTE markup is most appropriate — this fix is fine for this and given the number of times this seems to happen, waiting for 5.0 and the upgrade to python 3.0 etc seems to be reasonable.

comment:2 Changed 2 years ago by smk78

Leave prolog.rst alone for the time being due to possible unpredictable consequences on other rst docs.

comment:3 Changed 2 years ago by smk78

Removing emphasis fine for now. Closes #1164

comment:4 Changed 2 years ago by smk78

  • Resolution set to fixed
  • Status changed from new to closed
Note: See TracTickets for help on using tickets.