4. RecurDyn Issue¶
4.1. Search¶
PC serach result
Readthedocs result
Not easy to implement PC search result as Readthedocs result
4.2. PDF¶
4.2.1. GIF support¶
edit conf.py
#https://stackoverflow.com/questions/45969711/sphinx-doc-how-do-i-render-an-animated-gif-when-building-for-html-but-a-png-wh
from sphinx.builders.html import StandaloneHTMLBuilder
StandaloneHTMLBuilder.supported_image_types = [
'image/svg+xml',
'image/gif',
'image/png',
'image/jpeg'
]
edit *.rst
change ???.gif to ???.png
convert *.gif to *.png ( it’s done when converting docx )
4.3. Image¶
4.3.1. Convert image to png¶
convert *.gif, *.jpg, *.bmp to *.png ( it’s done when converting docx )
4.4. Reference to Other document¶
edit conf.py
extensions = [
'sphinx.ext.autosectionlabel',
]
autosectionlabel_prefix_document = True
4.4.1. Options¶
autosectionlabel_prefix_document = True
:ref:`20_TSG/20_TSG:TSG Overview`
:ref:`custom title <20_TSG/20_TSG:TSG Overview>`
autosectionlabel_prefix_document = False
:ref:`TSG Overview`
:ref:`custom title <TSG Overview>`
- RecurDyn uses
autosectionlabel_prefix_document = True
Example
Docx
Click `here <Working_Plane_Setup>`__.
Click `here <06_Body.docx#Use_Advanced_Graphical_Quality>`__.
RST
Click :ref:`here <03_home/03_home:Working Plane Setup>`
Click here :ref:`06_Body/06_Body:Use Advanced Graphical Quality>`.
4.5. Sphinx Build Wranings¶
4.5.1. WARNING: Inline emphasis start-string without end-string.¶
edit *.rst
=>
edit \*.rst
“*EIG_0001.RAN”, “*EIG_0002.RAN” and “*EIG_0003.RAN”.)
=>
“\*EIG_0001.RAN”, “\*EIG_0002.RAN” and “\*EIG_0003.RAN”.)
4.5.2. WARNING: Inline strong start-string without end-string.¶
the user can refer it in the directory (<install dir>/Help/DP_Study/**).
=>
the user can refer it in the directory (<install dir>/Help/DP_Study/\*\*).
4.5.3. WARNING: Error in “code-block” directive¶
.. code-block::
change ???.gif to ???.png
=>
.. code-block::
change ???.gif to ???.png
4.5.4. WARNING: Title level inconsistent¶
When converting 05_Analysis.docx, occurs level mismatch
Analysis
========
Dyn/Kin (Dynamic/Kinematic)
---------------------------
Property
^^^^^^^^
Parameter Page
''''''''''''''
Static
------
Property
~~~~~~~~
Parameter Page
^^^^^^^^^^^^^^
4.5.5. WARNING: Inline interpreted text or phrase reference start-string without end-string.¶
:math:`\zeta `
=>
:math:`\zeta`
:math:`{{f}_{n}}\equiv \sqrt{{{\lambda }'}}/2\pi `[Hz] (16-1)
=>
:math:`{{f}_{n}}\equiv \sqrt{{{\lambda }'}}/2\pi` [Hz] (16-1)
:math:`{{f}_{n}}\equiv \sqrt{{{\lambda }'}}/2\pi`[Hz] (16-1)
=>
:math:`{{f}_{n}}\equiv \sqrt{{{\lambda }'}}/2\pi` [Hz] (16-1)
where :math:`{{\lambda }_{r}}=-{{\omega }_{n}}\zeta`, |image8|
=>
where :math:`{{\lambda }_{r}}=-{{\omega }_{n}}\zeta` , |image8|
5. ProcessWord Issue¶
5.1. Equation Convert¶
Not supporting eq (1-1) (1-2) type. => fixed in ProcessWord.exe
<eq047> (16-2)
=>
.. :math:`equation`
label: 05_ana_eq046
Not supporting eq (1-1) (1-2) type. => User need to fix
<eq047>[Hz] (16-1)
=>
.. :math:`equation Hz`
label: 05_ana_eq047
<eq048>, |image001| (16-2)
=>
.. :math:`equation edit`
label: 05_ana_eq048
5.2. MathType Convert¶
When converting equation to NULL, kill mathtype.exe process and rerun ProcessWord.exe 8