-
Notifications
You must be signed in to change notification settings - Fork 6
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
feat: add quarto cheat sheet setup to docs build actions #528
Conversation
Thanks for opening a Pull Request. If you want to perform a review write a comment saying: @ansys-reviewer-bot review |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just some name suggestion:
78f8f7c
to
9141038
Compare
9141038
to
f35cc94
Compare
doc/source/cheat_sheet.qmd
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great! I am more concerned about the versions showing up in the file. Any chance we can use Jinja here? We could have a cheat_sheet.qmd.tpl
containing a {{ version }}
. We render this via conf.py
hooks so then it is built into the final cheatsheet. Also, we could include the code snippets we already have.
I know it is a bit of a burden but it alleviates all the maintenance of the docs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I understand this might be a bit challenging to implement, but I can give it a try.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great! Just left a comment on the automation of cheatsheets for this repo.
2a182d0
to
723f972
Compare
723f972
to
e211294
Compare
c8985c3
to
0b958b1
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the hard work with this, @Revathyvenugopal162. I just left some minor comments.
doc/source/cheat_sheet_new.qmd
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we really need to commit this file?
Co-authored-by: Jorge Martínez <[email protected]>
Co-authored-by: Jorge Martínez <[email protected]>
The syntax highlight for the YML code blocks in the cheatsheet seems to be the one for Python. Is it possible to change it to YML? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixing the highlight.
Co-authored-by: Jorge Martínez <[email protected]>
…ansys/actions into feat/add-quarto-pyansys-actions
Thanks for adding all the suggestions, @Revathyvenugopal162. Let's update the references and merge this. |
…ansys/actions into feat/add-quarto-pyansys-actions
_doc-build-windows/action.yml
Outdated
- name: "Install Jupyter for Quarto" | ||
if: ${{ inputs.needs-quarto == 'true' }} | ||
shell: bash | ||
run: | | ||
python -m pip install jupyter nbformat |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this required for Quarto to operate? This may be in conflict with packages declared inside of the libraries triggering the actions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need jupyter to convert qmd
files to pdf format
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As discussed, projects should be the ones adding their doc-extensions in the required extra target.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sure added it in d2b2f08, i will also add this requirement as a note in ansys sphinx theme docs
…ansys/actions into feat/add-quarto-pyansys-actions
cheat_sheet.pdf