Skip to content
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.

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

Migrate documentation to mkdocs #1810

Merged
merged 50 commits into from
Mar 25, 2024

Commits on Jan 20, 2024

  1. Demolish sphinx

    hypergonial committed Jan 20, 2024
    Configuration menu
    Copy the full SHA
    9405f96 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    98ab59e View commit details
    Browse the repository at this point in the history
  3. Add pages CD

    hypergonial committed Jan 20, 2024
    Configuration menu
    Copy the full SHA
    f6152a7 View commit details
    Browse the repository at this point in the history
  4. Remove sphinx session

    hypergonial committed Jan 20, 2024
    Configuration menu
    Copy the full SHA
    b9e1399 View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    b0c937b View commit details
    Browse the repository at this point in the history
  6. Add favicon

    hypergonial committed Jan 20, 2024
    Configuration menu
    Copy the full SHA
    23a9f3f View commit details
    Browse the repository at this point in the history

Commits on Jan 21, 2024

  1. Configuration menu
    Copy the full SHA
    fda74d1 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    6ffdec8 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    9b62648 View commit details
    Browse the repository at this point in the history
  4. Fix CI

    hypergonial committed Jan 21, 2024
    Configuration menu
    Copy the full SHA
    e6a2474 View commit details
    Browse the repository at this point in the history
  5. Build to public/docs

    hypergonial committed Jan 21, 2024
    Configuration menu
    Copy the full SHA
    7bde864 View commit details
    Browse the repository at this point in the history
  6. Adjust pages CI

    hypergonial committed Jan 21, 2024
    Configuration menu
    Copy the full SHA
    5fa08ac View commit details
    Browse the repository at this point in the history
  7. Merge dav changes

    davfsa committed Jan 21, 2024
    Configuration menu
    Copy the full SHA
    8ba5529 View commit details
    Browse the repository at this point in the history
  8. Remove docs github workflow

    - Just to avoid this being pushed anywhere and ruining our gh-pages branch
    davfsa committed Jan 21, 2024
    Configuration menu
    Copy the full SHA
    43adf8d View commit details
    Browse the repository at this point in the history
  9. Simplify summary write

    davfsa committed Jan 21, 2024
    Configuration menu
    Copy the full SHA
    b7361a1 View commit details
    Browse the repository at this point in the history
  10. Revert "Simplify summary write"

    This reverts commit b7361a1.
    davfsa committed Jan 21, 2024
    Configuration menu
    Copy the full SHA
    d3834a4 View commit details
    Browse the repository at this point in the history
  11. Configuration menu
    Copy the full SHA
    ff54c8c View commit details
    Browse the repository at this point in the history
  12. Fix mkdocs.yml

    hypergonial committed Jan 21, 2024
    Configuration menu
    Copy the full SHA
    629bac8 View commit details
    Browse the repository at this point in the history
  13. Remove mathjax

    It seems like we only use it in the internal module, which we are no longer documenting
    davfsa committed Jan 21, 2024
    Configuration menu
    Copy the full SHA
    0ed3dec View commit details
    Browse the repository at this point in the history
  14. Configuration menu
    Copy the full SHA
    df4e1d1 View commit details
    Browse the repository at this point in the history
  15. Remove smooth scrolling

    - For some reason, it doesn't work on chrome for large pages
    davfsa committed Jan 21, 2024
    Configuration menu
    Copy the full SHA
    6b8aa16 View commit details
    Browse the repository at this point in the history
  16. Fix issues pointed out in pr

    davfsa committed Jan 21, 2024
    Configuration menu
    Copy the full SHA
    849806e View commit details
    Browse the repository at this point in the history
  17. Configuration menu
    Copy the full SHA
    a00b1cc View commit details
    Browse the repository at this point in the history
  18. Configuration menu
    Copy the full SHA
    c0ccd6c View commit details
    Browse the repository at this point in the history
  19. Revert "Remove top level hikari reference page"

    This reverts commit c0ccd6c.
    davfsa committed Jan 21, 2024
    Configuration menu
    Copy the full SHA
    3e0aaf1 View commit details
    Browse the repository at this point in the history
  20. Configuration menu
    Copy the full SHA
    e5214b6 View commit details
    Browse the repository at this point in the history
  21. Add changelog fragment

    davfsa committed Jan 21, 2024
    Configuration menu
    Copy the full SHA
    564b506 View commit details
    Browse the repository at this point in the history
  22. Remove unnecessary gitignore

    davfsa committed Jan 21, 2024
    Configuration menu
    Copy the full SHA
    dc20503 View commit details
    Browse the repository at this point in the history
  23. Increment line length to 80

    davfsa committed Jan 21, 2024
    Configuration menu
    Copy the full SHA
    fe94b30 View commit details
    Browse the repository at this point in the history
  24. First code-block pass

    - Regex used: `^    \.\. code-block:: python\n\n((        .+|\n)+)\n^    """`
    - Replacement string: `    ```py\n$1\n    ```\n    """`
    davfsa committed Jan 21, 2024
    Configuration menu
    Copy the full SHA
    5b47b30 View commit details
    Browse the repository at this point in the history
  25. Second code-block pass

    - Regex used: `^    \.\. code-block:: python\n\n((        .+|\n)*)\n\n`
    - Replacement string: `    ```py\n$1\n    ```\n\n`
    davfsa committed Jan 21, 2024
    Configuration menu
    Copy the full SHA
    0d96cb8 View commit details
    Browse the repository at this point in the history
  26. Third code-block pass

    - Regex used: `^        \.\. code-block:: python\n\n((            .+|\n)*)\n\n`
    - Replacement string: `        ```py\n$1\n        ```\n\n`
    davfsa committed Jan 21, 2024
    Configuration menu
    Copy the full SHA
    efe4c3b View commit details
    Browse the repository at this point in the history
  27. Fourth code-block pass

    Manual fixes
    davfsa committed Jan 21, 2024
    Configuration menu
    Copy the full SHA
    db93fd4 View commit details
    Browse the repository at this point in the history
  28. Admonition blocks pass

    - Regex used: `\.\. (.+)::`
    - Replacement string: `!!! $1`
    davfsa committed Jan 21, 2024
    Configuration menu
    Copy the full SHA
    992466d View commit details
    Browse the repository at this point in the history
  29. Configuration menu
    Copy the full SHA
    b13df05 View commit details
    Browse the repository at this point in the history
  30. Configuration menu
    Copy the full SHA
    547ad2b View commit details
    Browse the repository at this point in the history
  31. Fix griffe warnings

    davfsa committed Jan 21, 2024
    Configuration menu
    Copy the full SHA
    67fb222 View commit details
    Browse the repository at this point in the history

Commits on Jan 22, 2024

  1. Fix broken admonishment

    hypergonial committed Jan 22, 2024
    Configuration menu
    Copy the full SHA
    7f1d88b View commit details
    Browse the repository at this point in the history

Commits on Jan 24, 2024

  1. Bump dependencies

    davfsa committed Jan 24, 2024
    Configuration menu
    Copy the full SHA
    0489ca6 View commit details
    Browse the repository at this point in the history

Commits on Jan 26, 2024

  1. Configuration menu
    Copy the full SHA
    0bb2c1d View commit details
    Browse the repository at this point in the history
  2. Partial work

    davfsa committed Jan 26, 2024
    Configuration menu
    Copy the full SHA
    a28862b View commit details
    Browse the repository at this point in the history

Commits on Feb 25, 2024

  1. Configuration menu
    Copy the full SHA
    688f3bb View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    789096d View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    a2e0b77 View commit details
    Browse the repository at this point in the history
  4. Fix failing tests

    Somehow managed to break tests in a documentation PR :))
    davfsa committed Feb 25, 2024
    Configuration menu
    Copy the full SHA
    be9b5b1 View commit details
    Browse the repository at this point in the history
  5. Properly fix failing tests

    davfsa committed Feb 25, 2024
    Configuration menu
    Copy the full SHA
    9193637 View commit details
    Browse the repository at this point in the history
  6. Configuration menu
    Copy the full SHA
    6091ca1 View commit details
    Browse the repository at this point in the history

Commits on Feb 26, 2024

  1. Migrate hikari-specific references to MkDocs (#1)

    References are searched using
        grep -n -r -P '(?<!``)`[a-zA-Z0-9._"]+`(?!``)' hikari/
    
    A bulk of the references found are migrated using variations of
        fd . hikari/ -x sd \
            '`(ADMINISTRATOR)`'
            '[hikari.permissions.Permissions.$1][]'
            {};
    
    References that are readily migratable are search using
        rg '`hikari\.[a-zA-Z0-9._]+`
    
    Such references are migrated with
        fd . hikari/ -x sd '`(hikari\.[a-zA-Z0-9._]+)`' '[$1][]' hikari/
    PythonTryHard authored Feb 26, 2024
    Configuration menu
    Copy the full SHA
    98a9b44 View commit details
    Browse the repository at this point in the history

Commits on Mar 2, 2024

  1. Migrate stdlib reference to MkDocs (#2)

    * Migrate stdlib reference to MkDocs
    
    * Address broken `.` references
    
    * Housekeeping: Backtick on unmigrated references
    
    * Correct additional Hikari references
    
    * Inline dunder to prevent incorrect bolding
    PythonTryHard authored Mar 2, 2024
    Configuration menu
    Copy the full SHA
    0878d3d View commit details
    Browse the repository at this point in the history

Commits on Mar 19, 2024

  1. Finalise MkDocs migration (#3)

    * Remove mention of deprecated GuildStoreChannel
    
    Deprecated and removed in hikari-py#1092
    
    * Minor spellchecking
    
    * MANAGE_INVITES is now CREATE_INSTANT_INVITES
    
    https://discord.com/developers/docs/resources/guild#add-guild-member
    
    * Migrate to MANAGE_GUILD_EXPRESSIONS
    
    * Expand GUILDER_MEMBERS intent
    
    * Expand `undefined`
    
    * Housekeeping: New line to appease formatter
    
    * Expand and beautify `hikari.undefined`'s docs
    
    * stdlib reference linking
    
    * Change "Bot" tab reference to Discord's Dev Portal
    
    This should be a good kickstarter. Should.
    
    * Add missing `position` arg in `add_role()`
    
    * Make `Intents`'s docs a bit more helpful
    
    * Address MkDocs' build warning
    
    * Housekeeping: Appease `flake8`
    
    * Migrate leftover backtick reference
    
    * Change MANAGE_PERMISSIONS to MANAGE_ROLES
    
    This could be verified by letting the bot have Manage Permissions
    permission in a channel and check that channel's overwrites.
    
    * Expand Webhook.token according to scope
    
    * More stdlib migration
    
    * Expand aliases
    
    * Migrate leftover MANAGE_INVITES
    
    * Expand Flag's reference
    
    * Typo fix
    
    * Expand BasicAuthHeader
    
    * Resolve READ_MESSAGE to VIEW_CHANNEL
    
    * Expand internal Enum
    
    * Expand MEMBERS to CacheComponent.MEMBERS
    
    * Bump MkDocs dependencies
    
    * Make cross-references inline code
    PythonTryHard authored Mar 19, 2024
    Configuration menu
    Copy the full SHA
    815e471 View commit details
    Browse the repository at this point in the history