Header icons not working for the SAF Light One Node repo with upgrade to v0.16.6

🔍 Before submitting the issue

[X] I have searched among the existing issues
[X] I am using a Python virtual environment

🐞 Description of the bug

The following issue was logged int the saf-light-one-node repo: Header Menu Disappears in Light Theme #483

To address this issue, I updated my local ansys-sphinx-theme clone to the current version, v0.16.6. This fixed the disappearing menu items in light mode, but introduced additional problems with header icons: neither the light/dark mode icon nor the search menu are working now. (Or the version switcher, though, I'm not sure if that was implemented/working previously).

📝 Steps to reproduce

Step 1: Reproduce for SAF Light One Node

These steps were performed in my local clone on the following branch: anskfletcher/saf-light-one-node/update_to_ansys-sphinx-theme16.6

Upgrade ansys-sphinx-theme to 0.16.6:
- Update pyproject.toml with new theme version.
- Delete the poetry.lock file.
- Run: poetry install --with doc
- Verify that the package version is updated in the new poetry.lock.
Do a local doc build:
- Run: sphinx-build doc/source doc/build/html --color -vW -bhtml
Review output in doc/build/html:

Step 2: Reproduce for SAF Desktop

I made the same upgrade in my local saf-desktop clone, and it also has these problems.

Step 3: Reproduce for Solution developer's guide

The same upgrade has been made my local solution-application-docs clone. However, these problems do not exist. (Note that doc versioning has never been implemented for this repo.)

Based on the above 3 scenarios, I'm guessing that the issues may not be with ansys-sphinx-design at all, but instead with the setup of the repos I've updated. There may be inconsistencies in how they were created, what dependencies they have, etc. (FWIW, I did start trying to diff the dependencies that might affect the theme, but realized pretty quickly that I have no idea and it's better to just ask for help...!)

💻 Which operating system are you using?

Windows

📀 Which ANSYS version are you using?

I am not running a product, only generating doc locally.

🐍 Which Python version are you using?

3.10

📦 Installed packages

(.venv) PS D:\AnsysDev\STC\SAF\saf-light-one-node> python -m pip freeze
accessible-pygments==0.0.5
alabaster==0.7.16
annotated-types==0.7.0
ansys-api-platform-instancemanagement==1.1.0
-e git+https://github.com/ansys-internal/saf-light-one-node.git@34da24eca57ebef66b768b8adb108a6ddd7a8f59#egg=ansys_app_portal_deployment_templates
ansys-optislang-core==0.7.1
ansys-platform-instancemanagement==1.1.2
-e git+https://github.com/ansys-internal/saf-light-one-node.git@34da24eca57ebef66b768b8adb108a6ddd7a8f59#egg=ansys_saf_light_one_node
ansys-sphinx-theme==0.16.6
anyio==4.4.0
apeye==1.4.1
apeye-core==1.1.5
arrow==1.3.0
attrs==23.2.0
autodoc_pydantic==2.2.0
autodocsumm==0.2.12
autopep8==2.3.1
Babel==2.15.0
backports.tarfile==1.2.0
beautifulsoup4==4.12.3
binaryornot==0.4.4
black==23.12.1
build==0.8.0
CacheControl==0.14.0
cachetools==5.3.3
cattrs==23.2.3
certifi==2024.6.2
cfgv==3.4.0
chardet==5.2.0
charset-normalizer==3.3.2
click==8.1.7
codespell==2.3.0
colorama==0.4.6
cookiecutter==2.6.0
coverage==6.5.0
cssutils==2.11.1
Deprecated==1.2.14
dict2css==0.3.0.post1
distlib==0.3.8
dnspython==2.6.1
docutils==0.20.1
domdf-python-tools==3.8.1
exceptiongroup==1.2.1
fastapi==0.110.3
filelock==3.15.4
grpcio==1.64.1
grpcio-health-checking==1.64.1
h11==0.14.0
html5lib==1.1
identify==2.5.36
idna==3.7
imagesize==1.4.1
importlib_metadata==8.0.0
iniconfig==2.0.0
isort==5.13.2
jaraco.classes==3.4.0
jaraco.context==5.3.0
jaraco.functools==4.0.1
Jinja2==3.1.4
keyring==25.2.1
LinkChecker==10.4.0
livereload==2.7.0
lsprotocol==2023.0.1
markdown-it-py==3.0.0
MarkupSafe==2.1.5
mdurl==0.1.2
mistune==2.0.5
more-itertools==10.3.0
msgpack==1.0.8
mypy-extensions==1.0.0
natsort==8.4.0
nh3==0.2.17
nodeenv==1.9.0
numpydoc==1.6.0
packaging==24.1
pathspec==0.12.1
pep517==0.13.1
pkginfo==1.10.0
platformdirs==4.2.2
pluggy==1.5.0
pre-commit==3.7.1
protobuf==5.27.2
psutil==5.9.8
py==1.11.0
pycodestyle==2.12.0
pydantic==2.7.4
pydantic-settings==2.3.4
pydantic_core==2.18.4
pydata-sphinx-theme==0.14.4
pygls==1.3.1
Pygments==2.18.0
pyproject-api==1.7.1
pyright==1.1.365
pytest==7.4.4
pytest-cov==4.1.0
pytest-html==3.2.0
pytest-md==0.2.0
pytest-metadata==3.1.1
pytest-mock==3.14.0
python-dateutil==2.9.0.post0
python-dotenv==1.0.1
python-slugify==8.0.4
pywin32-ctypes==0.2.2
PyYAML==6.0.1
readme_renderer==43.0
requests==2.32.3
requests-toolbelt==1.0.0
rfc3986==2.0.0
rich==13.7.1
ruamel.yaml==0.18.6
ruamel.yaml.clib==0.2.8
ruff==0.4.6
ruff-lsp==0.0.53
six==1.16.0
sniffio==1.3.1
snowballstemmer==2.2.0
soupsieve==2.5
Sphinx==7.2.6
sphinx-autobuild==2021.3.14
sphinx-autodoc-typehints==1.25.3
sphinx-code-tabs==0.5.5
sphinx-copybutton==0.5.2
sphinx-gallery==0.13.0
sphinx-jinja2-compat==0.3.0
sphinx-notfound-page==0.8.3
sphinx-prompt==1.8.0
sphinx-tabs==3.4.5
sphinx-toolbox==3.6.0
sphinx_design==0.5.0
sphinx_mdinclude==0.5.4
sphinxcontrib-applehelp==1.0.8
sphinxcontrib-devhelp==1.0.6
sphinxcontrib-htmlhelp==2.0.5
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.7
sphinxcontrib-serializinghtml==1.1.10
sphinxcontrib-websupport==1.2.7
sphinxemoji==0.2.0
starlette==0.37.2
tabulate==0.9.0
text-unidecode==1.3
toml==0.10.2
tomli==2.0.1
tornado==6.4.1
tox==4.15.1
twine==4.0.2
types-python-dateutil==2.9.0.20240316
typing_extensions==4.12.2
urllib3==1.26.19
uvicorn==0.29.0
virtualenv==20.26.3
webencodings==0.5.1
wrapt==1.16.0
zipp==3.19.2
(.venv) PS D:\AnsysDev\STC\SAF\saf-light-one-node>

Adding @Revathyvenugopal162 for visibility. @Revathyvenugopal162 could this actually be already fixed in the new coming release?

@anskfletcher Yes, all style-related issues will be resolved in the next release. However, there were no issues with the header styles in version 0.16.6, so it’s likely the update was not applied correctly. Additionally, the switcher value is not working due to versioning issues or internal documentation. Once you run the action in CI/CD, the switcher should be up and running .I can check it myself by afternoon on the CI/CD. Thank you for opening the issue and providing steps to reproduce it. We have not encountered any issues with the switcher from other libraries, but if the issue persists, I would be happy to look into it.

Hi Revathy. Thanks for the reply!

So, I'm guessing my first step, then, is to merge the update to main (which has not yet been done, it's all been local) so it goes through the proper CI/CD workflows and then check whether the problem exists in the doc deployed to GH Pages.

Then, if the doc still is not rendering correctly there, get DevOps help to see if something's amiss with how the CI/Cd actions are applied for the repo.

Does this sound right?

Thanks,

-Kelly

Kelly Fletcher / CSEBU Solutions Documentation

[cid:0cf778e9-fb77-45ad-ba57-2d0b7d4642a9]

@.***

www.ansys.comhttp://www.ansys.com

From: Revathy Venugopal @.> Sent: Monday, July 1, 2024 2:57 AM To: ansys/ansys-sphinx-theme @.> Cc: Kelly Fletcher @.>; Author @.> Subject: Re: [ansys/ansys-sphinx-theme] Header icons not working for the SAF Light One Node repo with upgrade to v0.16.6 (Issue #410)

[External Sender]

Yes, all style-related issues will be resolved in the next release. However, there were no issues with the header styles in version 0.16.6, so it’s likely the update was not applied correctly. Could you please check on this and let me know if it's working? Additionally, the switcher value is not working due to versioning issues or internal documentation. Once you run the action in CI/CD, the switcher should be up and running. Could you please check that as well and let me know if it's working? We have not encountered any issues with the switcher from other libraries, but if the issue persists, I would be happy to look into it.

— Reply to this email directly, view it on GitHubhttps://github.com/ansys/ansys-sphinx-theme/issues/410#issuecomment-2199382657, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AXUXHLEKNRM2GAQMTNCGPEDZKD4XPAVCNFSM6AAAAABKBQ6GLCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCOJZGM4DENRVG4. You are receiving this because you authored the thread.Message ID: @.***>

Hi Revathy. Thanks for the reply! So, I'm guessing my first step, then, is to merge the update to main (which has not yet been done, it's all been local) so it goes through the proper CI/CD workflows and then check whether the problem exists in the doc deployed to GH Pages. Then, if the doc still is not rendering correctly there, get DevOps help to see if something's amiss with how the CI/Cd actions are applied for the repo. Does this sound right? Thanks, … -Kelly Kelly Fletcher / CSEBU Solutions Documentation [cid:0cf778e9-fb77-45ad-ba57-2d0b7d4642a9] @. www.ansys.com<http://www.ansys.com> ____ From: Revathy Venugopal @.> Sent: Monday, July 1, 2024 2:57 AM To: ansys/ansys-sphinx-theme @.> Cc: Kelly Fletcher @.>; Author @.> Subject: Re: [ansys/ansys-sphinx-theme] Header icons not working for the SAF Light One Node repo with upgrade to v0.16.6 (Issue #410) [External Sender] Yes, all style-related issues will be resolved in the next release. However, there were no issues with the header styles in version 0.16.6, so it’s likely the update was not applied correctly. Could you please check on this and let me know if it's working? Additionally, the switcher value is not working due to versioning issues or internal documentation. Once you run the action in CI/CD, the switcher should be up and running. Could you please check that as well and let me know if it's working? We have not encountered any issues with the switcher from other libraries, but if the issue persists, I would be happy to look into it. — Reply to this email directly, view it on GitHub<#410 (comment)>, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AXUXHLEKNRM2GAQMTNCGPEDZKD4XPAVCNFSM6AAAAABKBQ6GLCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCOJZGM4DENRVG4. You are receiving this because you authored the thread.Message ID: @.>

yes, that is right. you just need to update the ci-cd

I’m closing this issue as it has been resolved and the documentation for SAF is working fine. If the problem persists, please feel free to open a new issue. Thank you!

ansys / ansys-sphinx-theme