Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating to ansys-sphinx-theme version 1.0.0 or higher shows the PyAnsys logo #597

Open
2 tasks done
anskfletcher opened this issue Dec 10, 2024 · 2 comments
Open
2 tasks done
Labels
bug Defects or glitches reported by users or developers

Comments

@anskfletcher
Copy link

🔍 Before submitting the issue

  • I have searched among the existing issues
  • I am using a Python virtual environment

🐞 Description of the bug

After updating to ansys-sphinx-theme version 1.0.0 or higher, the PyAnsys logo is shown in the doc header regardless of what is specified in the conf.py file (in this case, the Solutions logo).

📝 Steps to reproduce

  1. Verify that the Solutions logo is specified in conf.py.
    Image

  2. Verify the actual location of the Solutions logo.
    Image

  3. Set ansys-sphinx theme to version 0.9.9 or lower and build the doc locally.
    The Solutions logo is correctly shown in the header.
    Image

  4. Set ansys-sphinx theme to version 1.0.0 or higher and build the doc locally.
    The PyAnsys logo is now shown in the header.
    Image

💻 Which operating system are you using?

Windows

📀 Which ANSYS version are you using?

No Ansys products are associated with this doc repo.

🐍 Which Python version are you using?

3.10

📦 Installed packages

accessible-pygments==0.0.5
alabaster==0.7.16
annotated-types==0.7.0
ansys-sphinx-theme==1.2.3
autodoc_pydantic==2.2.0
babel==2.16.0
beautifulsoup4==4.12.3
cachetools==5.5.0
certifi==2024.8.30
cfgv==3.4.0
chardet==5.2.0
charset-normalizer==3.4.0
codespell==2.3.0
colorama==0.4.6
distlib==0.3.9
docutils==0.19
filelock==3.16.1
identify==2.6.2
idna==3.10
imagesize==1.4.1
importlib_metadata==8.5.0
Jinja2==3.1.4
livereload==2.7.0
MarkupSafe==3.0.2
mistune==2.0.5
nodeenv==1.9.1
numpydoc==1.8.0
packaging==24.2
pdf2image==1.17.0
pillow==11.0.0
platformdirs==4.3.6
pluggy==1.5.0
pre-commit==3.8.0
pydantic==2.10.1
pydantic-settings==2.6.1
pydantic_core==2.27.1
pydata-sphinx-theme==0.16.0
Pygments==2.18.0
pyproject-api==1.8.0
python-dotenv==1.0.1
PyYAML==6.0.2
requests==2.32.3
snowballstemmer==2.2.0
soupsieve==2.6
Sphinx==7.3.7
sphinx-autobuild==2021.3.14
sphinx-autodoc-typehints==1.23.0
sphinx-code-tabs==0.5.5
sphinx-copybutton==0.5.2
sphinx-gallery==0.13.0
sphinx-notfound-page==0.8.3
sphinx-tabs==3.4.7
sphinx_design==0.5.0
sphinx_mdinclude==0.5.4
sphinxcontrib-applehelp==2.0.0
sphinxcontrib-devhelp==2.0.0
sphinxcontrib-htmlhelp==2.1.0
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==2.0.0
sphinxcontrib-serializinghtml==2.0.0
sphinxcontrib-websupport==1.2.7
sphinxemoji==0.3.1
tabulate==0.9.0
toml==0.10.2
tomli==2.1.0
tornado==6.4.2
tox==4.23.2
typing_extensions==4.12.2
typos==1.27.3
urllib3==1.26.20
virtualenv==20.27.1
zipp==3.21.0
@anskfletcher anskfletcher added the bug Defects or glitches reported by users or developers label Dec 10, 2024
@RobPasMue
Copy link
Member

HI @anskfletcher - please have a look at the documentation:

https://sphinxdocs.ansys.com/version/stable/user-guide/configuration.html#pyansys-and-ansys-logos

It is shown how to properly use the logo starting on version 1.Y.Z versions.

html_theme_options = {
    "logo": "ansys",
    "logo_link": "https://www.example.com",
}

Make sure to remove the html_logo definition from your previous code snippet (as per the warning note).

@RobPasMue
Copy link
Member

Also, please close the issue if the above comment (#597 (comment)) solves your issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Defects or glitches reported by users or developers
Projects
None yet
Development

No branches or pull requests

2 participants