Move documentation from sphinx to mkdocs #178

codingjoe · 2025-12-17T14:56:08Z

No description provided.

Copilot

Pull request overview

This PR adds branded logo images to the repository and updates the README to display them at the top. The changes enhance the visual presentation of the project documentation by adding a professional logo with support for both light and dark color schemes.

Key Changes

Added two SVG logo variants (light and dark) to support different display themes
Updated README.rst to display the logo using HTML picture element for theme-aware rendering
Repositioned the existing sample.png screenshot to appear after the feature list

Reviewed changes

Copilot reviewed 1 out of 3 changed files in this pull request and generated no comments.

File	Description
images/logo-light.svg	New logo SVG file optimized for light theme backgrounds
images/logo-dark.svg	New logo SVG file optimized for dark theme backgrounds
README.rst	Added HTML raw block with picture element for theme-aware logo display; moved sample.png figure lower in the document

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

codecov · 2025-12-17T15:12:15Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.33%. Comparing base (746ccaa) to head (757a254).
⚠️ Report is 124 commits behind head on main.

❗ There is a different number of reports uploaded between BASE (746ccaa) and HEAD (757a254). Click for more details.

HEAD has 6 uploads less than BASE

Flag BASE (746ccaa) HEAD (757a254)

7 1

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #178      +/-   ##
==========================================
- Coverage   99.69%   93.33%   -6.37%     
==========================================
  Files          21       21              
  Lines         332      345      +13     
==========================================
- Hits          331      322       -9     
- Misses          1       23      +22

Flag	Coverage Δ
python-3.10	`93.04% <100.00%> (?)`
python-3.11	`93.04% <100.00%> (?)`
python-3.12	`93.04% <100.00%> (?)`
python-3.13	`93.04% <100.00%> (?)`
python-3.14	`93.04% <100.00%> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot

Pull request overview

Copilot reviewed 2 out of 4 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

mailauth/contrib/__init__.py

README.rst

Copilot

Pull request overview

Copilot reviewed 24 out of 28 changed files in this pull request and generated 14 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-17T18:13:17Z

docs/templates.md

+`registration/logged_out.html`
+
+This template will be displayed after a successful logout. This template
+is not proved Django or by the package and needs to be created.


Grammatical error: "This template is not proved Django or by the package" should be "This template is not provided by Django or by the package".

Copilot · 2025-12-17T18:13:17Z

README.md

+
+## Setup
+
+First add `mailauth` to you installed apps:


Grammatical error: "add mailauth to you installed apps" should be "add mailauth to your installed apps".

Copilot · 2025-12-17T18:13:17Z

.pre-commit-config.yaml

      - id: mdformat
        additional_dependencies:
-          - mdformat-ruff
          - mdformat-ruff


Duplicate dependency entry: "mdformat-ruff" is listed twice in the additional_dependencies list (lines 29 and line previously removed). This appears to be an error in the migration where line 29 should have been removed instead of line 28.

Suggested change

- mdformat-ruff

Copilot · 2025-12-17T18:13:18Z

docs/contributing.md

+
+## The sample app
+
+To run a full example --- e.g. to debug frontend code -- you can run:


Incorrect punctuation: "e.g. to debug frontend code --" should use a single dash "e.g. to debug frontend code -" instead of three dashes. Three dashes (---) is not standard for this context and may be rendered as an em dash depending on the markdown processor.

Suggested change

To run a full example --- e.g. to debug frontend code -- you can run:

To run a full example - e.g. to debug frontend code - you can run:

Copilot · 2025-12-17T18:13:18Z

mailauth/forms.py


-    def get_login_url(self, request, token, next=None):
+    def get_login_url(
+        self, request: django.http.request.HttpRequest, token: str, next: str = None


Type annotation issue: The parameter next should be typed as str | None instead of str = None for better clarity. While str = None works with PEP 484, the modern approach (with from __future__ import annotations) is to use str | None to explicitly indicate optionality.

Suggested change

self, request: django.http.request.HttpRequest, token: str, next: str = None

self, request: django.http.request.HttpRequest, token: str, next: str | None = None

Copilot · 2025-12-17T18:13:20Z

README.md

+That's it!
+
+> [!IMPORTANT]
+> Don't forget to setup you Email backend!


Grammatical error: "setup you Email backend" should be "setup your Email backend".

Suggested change

> Don't forget to setup you Email backend!

> Don't forget to setup your Email backend!

Copilot · 2025-12-17T18:13:20Z

docs/customizing.md

+[email][mailauth.contrib.user.models.AbstractEmailUser.email] field serves as a username and is -- different to Django's
+User -- unique and case-insensitive.


Inconsistent use of dashes: "is -- different to Django's User --" uses double dashes. Consider using standard em dashes or parentheses for better readability, such as "is (different to Django's User)" or "is—different to Django's User—".

Suggested change

[email][mailauth.contrib.user.models.AbstractEmailUser.email] field serves as a username and is -- different to Django's

User -- unique and case-insensitive.

[email][mailauth.contrib.user.models.AbstractEmailUser.email] field serves as a username and is—different to Django's

User—unique and case-insensitive.

Copilot · 2025-12-17T18:13:20Z

docs/contributing.md

+uv run tests/manage.py runserver
+```
+
+Next you can go to <https://localhost:8000/admin/> and log in with your


Invalid URL protocol: "https://localhost:8000/admin/" should use "http://localhost:8000/admin/" since localhost typically runs on HTTP by default, not HTTPS.

Suggested change

Next you can go to <https://localhost:8000/admin/> and log in with your

Next you can go to <http://localhost:8000/admin/> and log in with your

Copilot · 2025-12-17T18:13:20Z

README.md

+the following:
+
+```python
+from django.urls import path


Missing import statement: The code example uses include() function but doesn't import it. The import line should be from django.urls import path, include.

Suggested change

from django.urls import path

from django.urls import path, include

Copilot · 2025-12-17T18:13:21Z

docs/templates.md

+`registration/login_requested.html`
+
+This template will be displayed after a user successfully requested a
+login URL. This template is not proved by the package and needs to be


Grammatical error: "This template is not proved by the package" should be "This template is not provided by the package".

Copilot AI review requested due to automatic review settings December 17, 2025 14:56

codingjoe self-assigned this Dec 17, 2025

Copilot started reviewing on behalf of codingjoe December 17, 2025 14:56 View session

Copilot AI reviewed Dec 17, 2025

View reviewed changes

codingjoe force-pushed the readme branch 2 times, most recently from 8267598 to 5e0d2fc Compare December 17, 2025 15:10

Copilot AI review requested due to automatic review settings December 17, 2025 15:10

Copilot started reviewing on behalf of codingjoe December 17, 2025 15:11 View session

Copilot AI reviewed Dec 17, 2025

View reviewed changes

mailauth/contrib/__init__.py Show resolved Hide resolved

mailauth/contrib/__init__.py Show resolved Hide resolved

README.rst Outdated Show resolved Hide resolved

codingjoe force-pushed the readme branch from 5e0d2fc to 5df5cea Compare December 17, 2025 18:03

Copilot AI review requested due to automatic review settings December 17, 2025 18:06

codingjoe force-pushed the readme branch from 5df5cea to f174de9 Compare December 17, 2025 18:06

Copilot started reviewing on behalf of codingjoe December 17, 2025 18:07 View session

codingjoe force-pushed the readme branch from f174de9 to 8c481bc Compare December 17, 2025 18:08

Add image to readme

757a254

codingjoe force-pushed the readme branch from 8c481bc to 757a254 Compare December 17, 2025 18:09

codingjoe changed the title ~~Add image to readme~~ Move documentation from sphinx to mkdocs Dec 17, 2025

codingjoe merged commit 9cc5721 into main Dec 17, 2025
17 of 22 checks passed

codingjoe deleted the readme branch December 17, 2025 18:11

Copilot AI reviewed Dec 17, 2025

View reviewed changes


		## The sample app

		To run a full example --- e.g. to debug frontend code -- you can run:

	To run a full example --- e.g. to debug frontend code -- you can run:
	To run a full example - e.g. to debug frontend code - you can run:

	self, request: django.http.request.HttpRequest, token: str, next: str = None
	self, request: django.http.request.HttpRequest, token: str, next: str \| None = None

	> Don't forget to setup you Email backend!
	> Don't forget to setup your Email backend!

		[email][mailauth.contrib.user.models.AbstractEmailUser.email] field serves as a username and is -- different to Django's
		User -- unique and case-insensitive.

	Next you can go to <https://localhost:8000/admin/> and log in with your
	Next you can go to <http://localhost:8000/admin/> and log in with your

	from django.urls import path
	from django.urls import path, include

Uh oh!

Move documentation from sphinx to mkdocs #178

Move documentation from sphinx to mkdocs #178

Uh oh!

Conversation

codingjoe commented Dec 17, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Key Changes

Reviewed changes

Uh oh!

codecov bot commented Dec 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codecov bot commented Dec 17, 2025 •

edited

Loading