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

Add edit page button and link to GitHub in docs #342

Merged
merged 5 commits into from
Jun 18, 2024

Conversation

tovrstra
Copy link
Member

@tovrstra tovrstra commented Jun 18, 2024

One of the minor items in #204.

Based on:

I will YOLO-merge this on Friday, June 21, unless reviewed earlier

Summary by Sourcery

This pull request updates the documentation configuration to include a button for editing pages and a link to the GitHub repository, enhancing the user experience by providing easy access to the source code and the ability to contribute.

  • Documentation:
    • Added a button to edit pages and a link to the GitHub repository in the documentation.

Copy link
Contributor

sourcery-ai bot commented Jun 18, 2024

Reviewer's Guide by Sourcery

This pull request enhances the documentation by adding an 'Edit on GitHub' button and a GitHub link in the footer. The changes are implemented by modifying the 'docs/conf.py' file to include the necessary configurations and an embedded SVG for the GitHub icon.

File-Level Changes

Files Changes
docs/conf.py Enhanced the documentation configuration to include an 'Edit on GitHub' button and a GitHub link in the footer using the Furo theme options.

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link

deepsource-io bot commented Jun 18, 2024

Here's the code health analysis summary for commits d4bb73f..8eb9b17. View details on DeepSource ↗.

Analysis Summary

AnalyzerStatusSummaryLink
DeepSource Shell LogoShell✅ SuccessView Check ↗
DeepSource Python LogoPython✅ SuccessView Check ↗

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

@tovrstra tovrstra mentioned this pull request Jun 18, 2024
22 tasks
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @tovrstra - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

docs/conf.py Outdated Show resolved Hide resolved
docs/conf.py Show resolved Hide resolved
tovrstra and others added 3 commits June 18, 2024 12:18
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@tovrstra
Copy link
Member Author

Tests fail due to #340

Copy link
Member

@PaulWAyers PaulWAyers left a comment

Choose a reason for hiding this comment

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

Thanks Toon.

@tovrstra
Copy link
Member Author

Just to play safe, I'll merge main into this PR and rerun tests (with the NumPy 2 fix).

@tovrstra
Copy link
Member Author

Thanks for reviewing. merging...

@tovrstra tovrstra merged commit dc6f97c into theochem:main Jun 18, 2024
12 checks passed
@tovrstra tovrstra deleted the github-links branch June 18, 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