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.

Sign up for GitHub

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

Jump to bottom

feat: Add theme options for cheatsheet #346

Merged
merged 14 commits into from
Mar 13, 2024
Merged

feat: Add theme options for cheatsheet #346

merged 14 commits into from
Mar 13, 2024

Conversation

Revathyvenugopal162
Copy link
Collaborator

@Revathyvenugopal162 Revathyvenugopal162 commented Mar 12, 2024 •
edited

  • Add theme options to add cheatsheets
  • Add documentation for the options

outputs

conf.py

image

Rendering

image

Location with local_download:True option

image

@github-actions github-actions bot added documentation Improvements or additions to documentation enhancement New features or code improvements labels Mar 12, 2024
@Revathyvenugopal162 Revathyvenugopal162 marked this pull request as ready for review March 12, 2024 15:37
@Revathyvenugopal162 Revathyvenugopal162 requested a review from a team as a code owner March 12, 2024 15:37
jorgepiloto
jorgepiloto requested changes Mar 12, 2024
View reviewed changes
Copy link
Member

@jorgepiloto jorgepiloto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome impelementation! I just left some minor requests. Maybe some other team members want to also add new suggestions.

doc/source/user_guide/options.rst Outdated Show resolved Hide resolved
src/ansys_sphinx_theme/__init__.py Outdated Show resolved Hide resolved
doc/source/user_guide/options.rst Outdated Show resolved Hide resolved
src/ansys_sphinx_theme/__init__.py Outdated Show resolved Hide resolved
src/ansys_sphinx_theme/__init__.py Show resolved Hide resolved
src/ansys_sphinx_theme/theme/ansys_sphinx_theme/components/cheatsheet_sidebar.html Outdated Show resolved Hide resolved
klmcadams
klmcadams reviewed Mar 12, 2024
View reviewed changes
Copy link
Contributor

@klmcadams klmcadams left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me! I only had a suggestion on the wording of a sentence to clarify it

doc/source/user_guide/options.rst Outdated Show resolved Hide resolved
Revathyvenugopal162 and others added 4 commits March 12, 2024 18:11
@Revathyvenugopal162 @jorgepiloto @klmcadams
Apply suggestions from code review
4d23b78 
Co-authored-by: Jorge Martínez <28702884+jorgepiloto@users.noreply.github.com>
Co-authored-by: Kerry McAdams <58492561+klmcadams@users.noreply.github.com>
@Revathyvenugopal162
add static path
5acf27d
@Revathyvenugopal162
Merge branch 'feat/add-cheatsheet' of https://github.com/ansys/ansys-…
44c9fd8 
…sphinx-theme into feat/add-cheatsheet
@Revathyvenugopal162
add static path
64b396e
@Revathyvenugopal162
Copy link
Collaborator Author

any other static file
image

image

PipKat
PipKat approved these changes Mar 12, 2024
View reviewed changes
Copy link
Member

@PipKat PipKat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Revathyvenugopal162 Based on past Google searches and another one performed just now, "cheat sheet" is two words in the majority of cases. The titles of our existing cheat sheets also use it as two words. I propose that in the descriptive text (at least), we write it as two words.

src/ansys_sphinx_theme/__init__.py Outdated Show resolved Hide resolved
src/ansys_sphinx_theme/__init__.py Outdated Show resolved Hide resolved
src/ansys_sphinx_theme/__init__.py Outdated Show resolved Hide resolved
src/ansys_sphinx_theme/theme/ansys_sphinx_theme/static/css/ansys_sphinx_theme.css Outdated Show resolved Hide resolved
RobPasMue
RobPasMue approved these changes Mar 13, 2024
View reviewed changes
Copy link
Member

@RobPasMue RobPasMue left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM after all the team suggestions - awesome work @Revathyvenugopal162

@RobPasMue
Copy link
Member

Let's try and get this merged and released before the Thursday meeting so that we can present it to the group!

Revathyvenugopal162 and others added 2 commits March 13, 2024 09:13
@Revathyvenugopal162 @PipKat
Apply suggestions from code review
2bd960e 
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
@Revathyvenugopal162
docs: add note for static path
0def00e
@Revathyvenugopal162
Copy link
Collaborator Author

Let's try and get this merged and released before the Thursday meeting so that we can present it to the group!

Thank you all for the review, Sure we can merge this and before the Thursday meeting. i will testing this branch in one/two library and merge the PR

@Revathyvenugopal162
Copy link
Collaborator Author

check the branch with pymechanical ansys/pymechanical#638

@Revathyvenugopal162
Copy link
Collaborator Author

merging, thank you all.

@Revathyvenugopal162 Revathyvenugopal162 merged commit b842223 into main Mar 13, 2024
25 checks passed
@Revathyvenugopal162 Revathyvenugopal162 deleted the feat/add-cheatsheet branch March 13, 2024 15:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@RobPasMue RobPasMue RobPasMue approved these changes

@PipKat PipKat PipKat approved these changes

@klmcadams klmcadams Awaiting requested review from klmcadams

@jorgepiloto jorgepiloto Awaiting requested review from jorgepiloto

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New features or code improvements
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@Revathyvenugopal162 @RobPasMue @jorgepiloto @klmcadams @PipKat