Docs: Added sphinx-notfound-page plugin

[Seluj78]

Fixes #17

---

📚 Documentation preview 📚: https://flask-utils--18.org.readthedocs.build/en/18/

Summary by CodeRabbit

• Documentation
  • Enhanced documentation setup by adding support for custom 404 error pages.

[coderabbitai]

Walkthrough

This update introduces a 404 error page to the project's documentation by integrating the sphinx-notfound-page extension. The changes involve adding the necessary dependency to the docs/requirements.txt and updating the Sphinx configuration in conf.py to include the new extension.

Changes

File	Change Summary
docs/requirements.txt	Added sphinx-notfound-page to the list of dependencies.
docs/source/conf.py	Included "notfound.extension" in the list of Sphinx extensions.

Assessment against linked issues

Objective	Addressed	Explanation
Add a 404 page to the docs (#17)	✅

Poem

In the docs, a page was lost,
But now we've fixed it, at no great cost.
A 404 page now in sight,
Guiding the lost back to the light.
With Sphinx's help, we made it right,
Our documentation shines so bright! 🌟

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7f5037a and 85c9f5c.

Files selected for processing (2)

• docs/requirements.txt (1 hunks)
• docs/source/conf.py (1 hunks)

Files skipped from review due to trivial changes (2)

• docs/requirements.txt
• docs/source/conf.py