Skip to content

Reworked directories structure and added dark mode #81

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

Merged
merged 6 commits into from
Mar 16, 2025
Merged

Conversation

ericbsd
Copy link
Member

@ericbsd ericbsd commented Mar 16, 2025

Summary by Sourcery

Implements a dark mode toggle for the documentation and restructures the directories.

Enhancements:

  • Adds a dark mode toggle to the documentation, allowing users to switch between light and dark themes.
  • Restructures the project directories.
  • Updates the copyright year to 2025.
  • Adds dark mode CSS and JavaScript files.
  • Adds the sphinx_rtd_theme extension to the Sphinx configuration.
  • Moves the source directory to the root directory.

@ericbsd ericbsd requested review from a team as code owners March 16, 2025 01:59
Copy link
Contributor

sourcery-ai bot commented Mar 16, 2025

Reviewer's Guide by Sourcery

This pull request introduces a dark mode feature to the documentation and restructures the directory. It includes CSS and JavaScript files for dark mode styling and functionality, updates the Sphinx configuration to include these files, and modifies the Makefile and make.bat to reflect the change in source directory.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Implements a dark mode feature using CSS and JavaScript.
  • Added dark_mode.css to define styles for dark mode.
  • Added dark_mode.js to toggle dark mode based on user preference and system settings.
  • Added a toggle button to the breadcrumbs section to switch between light and dark modes.
  • Persists the user's dark mode preference in local storage.
  • Applies dark mode styles based on the presence of the dark-mode class on the body element.
b/_static/dark_mode.css
b/_static/dark_mode.js
source/conf.py
Updates the Sphinx configuration file.
  • Added sphinx_rtd_theme to the extensions list.
  • Added dark_mode.css to html_css_files to include the dark mode stylesheet.
  • Added dark_mode.js to html_js_files to include the dark mode script.
  • Changed the copyright year to 2025.
source/conf.py
Updates the Makefile and make.bat to change the source directory.
  • Changed SOURCEDIR from source to ..
Makefile
make.bat

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

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 @ericbsd - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider using CSS variables for colors in dark_mode.css to make it easier to manage and modify the theme.
  • The change to copyright looks like a typo - is it meant to be 2025?
Here's what I looked at during the review
  • 🟡 General issues: 1 issue 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 and I'll use the feedback to improve your reviews.

@ericbsd ericbsd merged commit 9916c0e into master Mar 16, 2025
1 check passed
@ericbsd ericbsd deleted the dark-mode branch March 16, 2025 02:41
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.

1 participant