search

ansys / ansys-sphinx-theme

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

Update options.rst #369

Closed PipKat closed 5 months ago

PipKat commented 5 months ago

@Revathyvenugopal162 I wanted to update this page of the Ansys Sphinx theme, especially to always make cheat sheet two words (except for the actual option name). I thought you could have more than one cheat sheet shown on a page and that you demoed this at some point. However, I don't see a way to do this. Is there a new option not yet documented?

Also, the action and Vale location both need to be updated. If you have time to do this before I start my day on Monday, I'd greatly appreciate it! (If not, I'll try to do it myself.)

Revathyvenugopal162 commented 5 months ago

@Revathyvenugopal162 I wanted to update this page of the Ansys Sphinx theme, especially to always make cheat sheet two words (except for the actual option name). I thought you could have more than one cheat sheet shown on a page and that you demoed this at some point. However, I don't see a way to do this. Is there a new option not yet documented?

Also, the action and Vale location both need to be updated. If you have time to do this before I start my day on Monday, I'd greatly appreciate it! (If not, I'll try to do it myself.)

Thank you for the PR @PipKat , i will fix the vale issue. for the moment we can add only one cheat sheet on a page. but i can update the code on another PR to add multiple cheat sheets

PipKat commented 5 months ago

@Revathyvenugopal162 I wanted to update this page of the Ansys Sphinx theme, especially to always make cheat sheet two words (except for the actual option name). I thought you could have more than one cheat sheet shown on a page and that you demoed this at some point. However, I don't see a way to do this. Is there a new option not yet documented? Also, the action and Vale location both need to be updated. If you have time to do this before I start my day on Monday, I'd greatly appreciate it! (If not, I'll try to do it myself.)

Thank you for the PR @PipKat , i will fix the vale issue. for the moment we can add only one cheat sheet on a page. but i can update the code on another PR to add multiple cheat sheets

@Revathyvenugopal162 Thanks for fixing the Vale setup. Feel free to review and merge this PR, making any changes you feel are necessary. Since PyMechanical seems to the only one using this feature so far, you can add the code to add multiple cheat at your convenience. You can then update the doc and tag me as the reviewer if you want. Thanks again!

PipKat commented 5 months ago

@Revathyvenugopal162 Also, I had a note that that this repo needed to be updated to doc-style@v6. Not sure if you handled this or need to delay if for some reason. Just thought I'd mentioned it.

Revathyvenugopal162 commented 5 months ago

@Revathyvenugopal162 Also, I had a note that that this repo needed to be updated to doc-style@v6. Not sure if you handled this or need to delay if for some reason. Just thought I'd mentioned it.

sure , thanks for pointing, i will update those.