Move to mkdocs

[ItsDrike]

This removes Sphinx in favor of mkdocs for the project documentation.

Mkdocs is a major improvement on Sphinx, bringing us modern looking UI and markdown-based documentation source (rather than rst based with sphinx). The mkdocs syntax is much easier to follow and their usage documentation is a lot more user-friendly, making it generally much easier to write new documentation.

This PR doesn't just move the existing documentation over to mkdocs, rather, it's pretty much a complete rewrite, introducing a lot of new content and greatly modifying almost all of the old pages. This PR fully completes the project documentation task (#19).

Warning

Python docstrings originally written for Sphinx aren't entirely compatible with mkdocs. Even though some basic sphinx formatting is supported, mkdocs is better suited for different docstring formats, like the google or numpy formats, with additional formatting being just the mkdocs markdown. I haven't yet decided whether to keep using sphinx and only resolve the incompatibilities, resulting in docstrings which are half rst, half markdown, or whether to move to one of these other doctring formats.

---

• Automatic deployment to GitHub pages
• Versioned docs
• Meta pages
  • Introduction
  • Installation category
    • Installation guide
    • Versioning Model
      • Version guarantees
      • Our versioning practices (how mcproto updates with mc protocol updates)
    • Changelog (released changes)
      • Show the existing CHANGELOG.md file in the docs
      • Show upcomming changes using some kind of towncrier integration
• Usage guides
  • Authentication
  • Manual (low-level) mcproto usage (example from readme)
  • Usage with packet classes (example from readme)
• Frequently Asked Questions?
  • Differences between mcproto and other libs (quarry)?
  • Why some methods lack sync alternatives (see existing page here)
• Community category
  • Code of Conduct
  • Attributions
  • License
• Contributing category
  • Reporting a bug
  • Proposing a feature?
  • Asking a question
  • Making a pull request
  • Security Policy
  • Contributing guidelines
    • Index
    • Setting up the project
    • Style Guide
    • Docstring formatting directive
    • Type hinting
    • Slotscheck
    • Pre-commit
    • Changelog
    • Great commits
    • Unit Tests
    • Breaking changes & Deprecations
    • Writing Documentation
• API Reference
  • Basic setup for docs autogeneration
  • Outline which features belong to public API and which are considered internal/private
  • Resolve Sphinx style incompatibilities
  • Solve issue with duplicate headers between private & public docs, leading to warnings

[github-actions]

PR Preview Action v1.5.0
🚀 Deployed preview to https://py-mine.github.io/mcproto/pr-preview/pr-346/
on branch gh-pages at 2025-01-08 16:43 UTC