ansys / ansys-sphinx-theme

PyData-based Sphinx theme from the PyAnsys community
https://sphinxdocs.ansys.com
MIT License
21 stars 5 forks source link

The topic directive renders as a blank box. #342

Closed anskfletcher closed 4 months ago

anskfletcher commented 5 months ago

šŸ” Before submitting the issue

šŸž Description of the bug

Previously, the title and contents of a .. topic:: directive was rendered as text within the gray topic box.

Example: Electric Machine Thermal customer doc

(https://expert-adventure-19g81ev.pages.github.io/_sources/user_guide/motor_cad_analysis.html):

image image

In version 0.13.3, the title and contents are are no longer shown in the output.

Example: Solution developer's guide

(https://dev-docs.solutions.ansys.com/version/dev/getting_started/quick_start.html#quick-start)

image image

šŸ“ Steps to reproduce

  1. To an RST file, add a .. topic:: directive with title and content.
  2. Generate the documentation and check the output.

The issue is present in the output for both local doc builds and GitHub builds using the ansys-internal/solution-applications-actions/build-doc@v11 action.

šŸ’» Which operating system are you using?

Windows

šŸ“€ Which ANSYS version are you using?

NA.

šŸ Which Python version are you using?

3.10

šŸ“¦ Installed packages

Package                       Version
----------------------------- -----------
accessible-pygments           0.0.4
alabaster                     0.7.16
ansys-sphinx-theme            0.13.3
apeye                         1.4.1
apeye-core                    1.1.5
attrs                         23.2.0
autodocsumm                   0.2.12
Babel                         2.14.0
beautifulsoup4                4.12.3
bleach                        6.1.0
CacheControl                  0.14.0
certifi                       2024.2.2
charset-normalizer            3.3.2
click                         8.1.7
colorama                      0.4.6
cssutils                      2.9.0
defusedxml                    0.7.1
dict2css                      0.3.0.post1
dnspython                     2.5.0
docutils                      0.20.1
domdf-python-tools            3.8.0.post2
fastjsonschema                2.19.1
filelock                      3.13.1
html5lib                      1.1
idna                          3.6
imagesize                     1.4.1
importlib-metadata            7.0.1
Jinja2                        3.1.3
jsonschema                    4.21.1
jsonschema-specifications     2023.12.1
jupyter_client                8.6.0
jupyter_core                  5.7.1
jupyterlab_pygments           0.3.0
LinkChecker                   10.4.0
MarkupSafe                    2.1.5
mistune                       3.0.2
msgpack                       1.0.7
natsort                       8.4.0
nbclient                      0.9.0
nbconvert                     7.15.0
nbformat                      5.9.2
nbsphinx                      0.8.12
numpydoc                      1.6.0
packaging                     23.2
pandocfilters                 1.5.1
pillow                        10.2.0
pip                           24.0
platformdirs                  4.2.0
pydata-sphinx-theme           0.14.4
Pygments                      2.17.2
python-dateutil               2.8.2
pywin32                       306
pyzmq                         25.1.2
referencing                   0.33.0
requests                      2.31.0
rpds-py                       0.17.1
ruamel.yaml                   0.18.5
ruamel.yaml.clib              0.2.8
setuptools                    63.2.0
six                           1.16.0
snowballstemmer               2.2.0
soupsieve                     2.5
Sphinx                        7.2.6
sphinx-autodoc-typehints      1.25.3
sphinx-code-tabs              0.5.5
sphinx-copybutton             0.5.2
sphinx_design                 0.5.0
sphinx-gallery                0.15.0
sphinx-jinja2-compat          0.2.0.post1
sphinx-prompt                 1.8.0
sphinx-tabs                   3.4.5
sphinx-toolbox                3.5.0
sphinxcontrib-applehelp       1.0.8
sphinxcontrib-devhelp         1.0.6
sphinxcontrib-htmlhelp        2.0.5
sphinxcontrib-jsmath          1.0.1
sphinxcontrib-mermaid         0.7.1
sphinxcontrib-qthelp          1.0.7
sphinxcontrib-serializinghtml 1.1.10
sphinxemoji                   0.2.0
tabulate                      0.9.0
tinycss2                      1.2.1
toml                          0.10.2
tomli                         2.0.1
tornado                       6.4
traitlets                     5.14.1
typing_extensions             4.9.0
urllib3                       2.2.0
vale                          2.30.0.0
webencodings                  0.5.1
zipp                          3.17.0