Add tutorials and update User Guide layout #1749
Conversation
luisaFelixSalles
added
the
documentation
PProfizi
changed the title
doc/source/conf.py
Outdated
| @@ -193,7 +194,7 @@ def reset_servers(gallery_conf, fname, when): | |||
| # -- Options for HTML output ------------------------------------------------- | |||
| html_short_title = html_title = "PyDPF-Core" | |||
| html_theme = "ansys_sphinx_theme" | |||
| html_logo = pyansys_logo_black | |||
| html_logo = pyansys_logo_light_mode | |||
There was a problem hiding this comment.
@luisaFelixSalles why do we need this change? Is it going to work in dark mode?
There was a problem hiding this comment.
The current nav bar looks like this:
The logo has a black square background, but we dont see it because the navigation bar also has a black background.:
So, I changed the logo for the one with a light back ground, to match the new navigation bar color. It actually doesn't look good in dark mode, I'll look into other projects to see how they do it
There was a problem hiding this comment.
@Revathyvenugopal162 I would like to ask for your help also in this case:
I tried passing the logo as an html configuration option with:
But I get the following error when building the documentation:
Do you know if I'm missing other configuration changes in other to solve this problem?
There was a problem hiding this comment.
This wont work with out new theme. Please add this "logo": "pyansys" in theme options. example PR , ansys/pyansys-geometry@40366c1#diff-d8d3ed25802824d15bf411f8e97416d8fc6f9247e821b0617f2b869dc584b99c
There was a problem hiding this comment.
I tried this but it gives me the same error.
Is there a way to implement the logo (that respects the light and dark modes) with the new theme?
There was a problem hiding this comment.
@luisaFelixSalles @PProfizi The logo issue was fixed in 33fade6 and this is the first time we are getting this issue. i will keep track on this and try to fix it in ansys sphinx theme if required. The recommended way is using "logo":"pyansys" in theme options.
There was a problem hiding this comment.
Thank you for your help ! 🙂
requirements/requirements_docs.txt
Outdated
| sphinxcontrib-napoleon==0.7 | ||
| ansys-sphinx-theme[autoapi]==1.0.8 | ||
| numpydoc==1.8.0 |
There was a problem hiding this comment.
@luisaFelixSalles here you have to either run the pre-commit hooks or to order them alphabetically yourself. Also leave an empty line at the end of the file.
Co-authored-by: Paul Profizi <100710998+PProfizi@users.noreply.github.com>
Co-authored-by: Paul Profizi <100710998+PProfizi@users.noreply.github.com>
doc/source/conf.py
Outdated
| @@ -193,7 +194,7 @@ def reset_servers(gallery_conf, fname, when): | |||
| # -- Options for HTML output ------------------------------------------------- | |||
| html_short_title = html_title = "PyDPF-Core" | |||
| html_theme = "ansys_sphinx_theme" | |||
| html_logo = pyansys_logo_black | |||
| html_logo = pyansys_logo_light_mode | |||
There was a problem hiding this comment.
| html_logo = pyansys_logo_light_mode |
yes you need to remove this line, and then add "logo":"pyansys", in html theme options. That should work
There was a problem hiding this comment.
I just test this variation and it still gives me the same error
There was a problem hiding this comment.
let me try it locally.
There was a problem hiding this comment.
yes, you are correct, and i think it is because of some mismatch in configuration. i can fix with with another workaround and push that changes if its ok for you
…thub.com/ansys/pydpf-core into doc/documentation-adjustments-new-layout
This PR changes the general layout of the user guide documentation section