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

docs: Removed betterem extension from mkdocs.yml to improve rendering #94

Merged
merged 2 commits into from
Aug 1, 2024

Conversation

samarth8392
Copy link
Collaborator

Changes

Removed pymdownx.betterem extension from mkdocs.yml file to improve the XAVIER rendering on the documentation website.

Issues

Related to #93.

PR Checklist

(Strikethrough any points that are not applicable.)

  • This comment contains a description of changes with justifications, with any relevant issues linked.
  • [ ] Update docs if there are any API changes.
  • Update CHANGELOG.md with a short description of any user-facing changes and reference the PR number. Guidelines: https://keepachangelog.com/en/1.1.0/

Comment on lines 4 to +5
- Minor documentation improvements. (#92, @kelly-sovacool)
- Minor documentation rendering improvements (#93, @samarth8392)
Copy link
Member

Choose a reason for hiding this comment

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

We can consolidate these entries to one line:

Suggested change
- Minor documentation improvements. (#92, @kelly-sovacool)
- Minor documentation rendering improvements (#93, @samarth8392)
- Minor documentation improvements. (#92, @kelly-sovacool; #93, @samarth8392)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Sorry didn't see your comment before I pulled the trigger on merging the PR. I have other issues to work on, will change it in the next PR.

Copy link
Member

Choose a reason for hiding this comment

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

@samarth8392 no worries!

@samarth8392 samarth8392 merged commit c327d71 into main Aug 1, 2024
2 checks passed
@samarth8392 samarth8392 deleted the doc-hotfix branch August 1, 2024 18:12
@kelly-sovacool kelly-sovacool restored the doc-hotfix branch August 1, 2024 18:35
@kelly-sovacool kelly-sovacool deleted the doc-hotfix branch August 1, 2024 18:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants