Skip to content

Add sphinx project name and version #523

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

Merged
codingjoe merged 1 commit into from
Dec 19, 2025
Merged

Add sphinx project name and version #523

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,7 @@
import health_check

project = "Django HealthCheck"
Copy link

Copilot AI Dec 19, 2025

Choose a reason for hiding this comment

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

The project name "Django HealthCheck" is inconsistent with the project's established naming convention. Throughout the codebase (README.md, docs/index.rst, pyproject.toml), the project is consistently referred to as "django-health-check". Consider using "django-health-check" instead to maintain consistency with the project's branding and documentation.

Suggested change
project = "Django HealthCheck"
project = "django-health-check"

Copilot uses AI. Check for mistakes.
version = f"{health_check.VERSION[0]}.{health_check.VERSION[1]}"
Copy link

Copilot AI Dec 19, 2025

Choose a reason for hiding this comment

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

Accessing VERSION tuple elements by index without validation could fail if the version tuple has fewer than 2 elements. While setuptools_scm typically generates version tuples with at least major and minor components, it's safer to handle edge cases. Consider adding validation or using a more defensive approach, such as checking the tuple length first or using try-except to handle potential IndexError.

Suggested change
version = f"{health_check.VERSION[0]}.{health_check.VERSION[1]}"
version_info = getattr(health_check, "VERSION", None)
if isinstance(version_info, (tuple, list)) and len(version_info) >= 2:
version = f"{version_info[0]}.{version_info[1]}"
else:
version = getattr(health_check, "__version__", "")

Copilot uses AI. Check for mistakes.
release = health_check.__version__
master_doc = "index"
html_theme = "furo"