Code

Move to mkdocs#346

Code

Draft

ItsDrike wants to merge 74 commits intomainpy-mine/mcproto:mainfrom mkdocspy-mine/mcproto:mkdocsCopy head branch name to clipboard

+4,231-2,107

Commits

Commits on Jan 8, 2025

• Move to mkdocs

  ItsDrike

  committed
  861a464

  Copy full SHA for 861a464

• Add mike for mkdocs versioning

  ItsDrike

  committed
  f197160

  Copy full SHA for f197160

• Add changelog fragment for 346

  ItsDrike

  committed
  a6b02b1

  Copy full SHA for a6b02b1

• Split off the installation page to its own tab

  ItsDrike

  committed
  c738b5e

  Copy full SHA for c738b5e

• Add changelog file (incomplete)

  ItsDrike

  committed
  a8af978

  Copy full SHA for a8af978

• Add code of conduct and license pages

  ItsDrike

  committed
  63456ee

  Copy full SHA for 63456ee

• Include changelog.md

  ItsDrike

  committed
  552edfd

  Copy full SHA for 552edfd

• Add attribution page to docs

  ItsDrike

  committed
  ca459c8

  Copy full SHA for ca459c8

• Add bug reporting instructions

  ItsDrike

  committed
  8be3bae

  Copy full SHA for 8be3bae

• Use new link to code of conduct docs

  ItsDrike

  committed
  965432f

  Copy full SHA for 965432f

• Add next steps section to reporting_a_bug page

  ItsDrike

  committed
  9c7ae15

  Copy full SHA for 9c7ae15

• Add making_a_pr.md & template for contributing guides

  ItsDrike

  committed
  ad66411

  Copy full SHA for ad66411

• Multiple minor fixes in the version guarantees page

  ItsDrike

  committed
  1301c36

  Copy full SHA for 1301c36

• Add work-in-progress notices

  ItsDrike

  committed
  d45ce98

  Copy full SHA for d45ce98

• Fix docs url for code-of-conduct

  ItsDrike

  committed
  9ce5cbe

  Copy full SHA for 9ce5cbe

• Use dashes instead of underscores in file names

  ItsDrike

  committed
  7fb9d3a

  Copy full SHA for 7fb9d3a

• Improve directory structure of docs/

  ItsDrike

  committed
  d50d4eb

  Copy full SHA for d50d4eb

• Add contributing guidelines index page

  ItsDrike

  committed
  d524cdd

  Copy full SHA for d524cdd

• Add project setup instructions

  ItsDrike

  committed
  4779201

  Copy full SHA for 4779201

• Add note about skipping issues for minor tasks

  ItsDrike

  committed
  ad65eac

  Copy full SHA for ad65eac

• Add the golden rules of contributing

  ItsDrike

  committed
  37081fd

  Copy full SHA for 37081fd

• Note about skipping guide pages

  ItsDrike

  committed
  df6c3d8

  Copy full SHA for df6c3d8

• Add assumptions setup guide makes

  ItsDrike

  committed
  cc556ec

  Copy full SHA for cc556ec

• Add style guide

  ItsDrike

  committed
  530890a

  Copy full SHA for 530890a

• Add docstrings & other-tools (blank) pages

  ItsDrike

  committed
  75814bf

  Copy full SHA for 75814bf

• Add the PEP8 song!

  ItsDrike

  committed
  49635d2

  Copy full SHA for 49635d2

• Remove wip banner from style guide

  ItsDrike

  committed
  1b92afd

  Copy full SHA for 1b92afd

• Update licence 3rd party

  ItsDrike

  committed
  692c388

  Copy full SHA for 692c388

• Mention using an existing fork for new contributions

  ItsDrike

  committed
  ceee358

  Copy full SHA for ceee358

• Explain CI & code reviews

  ItsDrike

  committed
  576b714

  Copy full SHA for 576b714

• Add type hints page

  ItsDrike

  committed
  51a2faf

  Copy full SHA for 51a2faf

• Update installation commands

  ItsDrike

  committed
  34760a7

  Copy full SHA for 34760a7

• Use markdown-exec to dynamically run python code in docs

  ItsDrike

  committed
  90208af

  Copy full SHA for 90208af

• Update changelog & change fragments to render properly

  ItsDrike

  committed
  15e783f

  Copy full SHA for 15e783f

• Watch some external files for reloading docs

  ItsDrike

  committed
  002ef41

  Copy full SHA for 002ef41

• Fetch the entire git history for mkdocs workflow

  ItsDrike

  committed
  a00e373

  Copy full SHA for a00e373

• Add towncrier to docs dependencies

  ItsDrike

  committed
  ea5453b

  Copy full SHA for ea5453b

• Fix reference

  ItsDrike

  committed
  88120f2

  Copy full SHA for 88120f2

• Add changelog explanation

  ItsDrike

  committed
  d489138

  Copy full SHA for d489138

• Fix reference to git-pull

  ItsDrike

  committed
  d31ac65

  Copy full SHA for d31ac65

• Add some todos

  ItsDrike

  committed
  c6aa145

  Copy full SHA for c6aa145

• Fix some typos in the docs

  ItsDrike

  committed
  276e448

  Copy full SHA for 276e448

• License the docs itself under CC BY-NC-SA 4.0

  ItsDrike

  committed
  6d2df91

  Copy full SHA for 6d2df91

• Add great commits guide

  ItsDrike

  committed
  56bca38

  Copy full SHA for 56bca38

• Remove license from coc (docs now have global cc license)

  ItsDrike

  committed
  ceac1c1

  Copy full SHA for ceac1c1

• Add tip about skipping internal changelog changes

  ItsDrike

  committed
  aa92255

  Copy full SHA for aa92255

• Add section for running basedpyright from cli

  ItsDrike

  committed
  162ca6c

  Copy full SHA for 162ca6c

• Add pre-commit docs

  ItsDrike

  committed
  1689706

  Copy full SHA for 1689706

• Add slotscheck page

  ItsDrike

  committed
  46d68a9

  Copy full SHA for 46d68a9

• Update docs taskipy task to use mkdocs

  ItsDrike

  committed
  fb6864a

  Copy full SHA for fb6864a

• Add link to slotscheck config docs

  ItsDrike

  committed
  6031606

  Copy full SHA for 6031606

• Add API reference (with mkdocstrings)

  ItsDrike

  committed
  ec1ffdb

  Copy full SHA for ec1ffdb

• Add authentication usage guide

  ItsDrike

  committed
  6ddf5f6

  Copy full SHA for 6ddf5f6

• Improve wording in coc

  ItsDrike

  committed
  8d59169

  Copy full SHA for 8d59169

• Properly show all private members

  ItsDrike

  committed
  89415e9

  Copy full SHA for 89415e9

• Add private api docs for packets

  ItsDrike

  committed
  4210716

  Copy full SHA for 4210716

• Add notice for pending rewrite of packets docs

  ItsDrike

  committed
  31e8c5b

  Copy full SHA for 31e8c5b

• Show the buffer class properly

  ItsDrike

  committed
  12a4610

  Copy full SHA for 12a4610

• Remove unnecessary indent from exaple code in docs

  ItsDrike

  committed
  ddf6f04

  Copy full SHA for ddf6f04

• Add copyright notice to footer

  ItsDrike

  committed
  ef5facc

  Copy full SHA for ef5facc

• Add custom css for mkdocstrings

  ItsDrike

  committed
  4fcb0a4

  Copy full SHA for 4fcb0a4

• Add extra css styles for material theme

  ItsDrike

  committed
  ee5473f

  Copy full SHA for ee5473f

• Add custom important admodition

  ItsDrike

  committed
  9095412

  Copy full SHA for 9095412

• Write breaking changes & deprecations guide

  ItsDrike

  committed
  3ada2fe

  Copy full SHA for 3ada2fe

• Add wip documentation guide

  ItsDrike

  committed
  af0c95a

  Copy full SHA for af0c95a

• Use important block for code quality requiements

  ItsDrike

  committed
  517948f

  Copy full SHA for 517948f

• Use tip block for guide skipping paragraph

  ItsDrike

  committed
  5eeef22

  Copy full SHA for 5eeef22

• Explain the versioning model of mcproto

  ItsDrike

  committed
  fcb181b

  Copy full SHA for fcb181b

• Update the ordering of some contributing guides

  ItsDrike

  committed
  609cc54

  Copy full SHA for 609cc54

• Move usage guides from readme to docs

  ItsDrike

  committed
  4dbf0d7

  Copy full SHA for 4dbf0d7

• Mention which packages will/won't get deprecated explicitly

  ItsDrike

  committed
  4dca825

  Copy full SHA for 4dca825

• Fix various typos and wording

  ItsDrike

  committed
  3d6119f

  Copy full SHA for 3d6119f

• Add FAQ page

  ItsDrike

  committed
  11ac6cc

  Copy full SHA for 11ac6cc

• Add security policy

  ItsDrike

  committed
  32504c5

  Copy full SHA for 32504c5