-
-
Notifications
You must be signed in to change notification settings - Fork 94
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
FasterSpeeding
merged 50 commits into
hikari-py:master
from
hypergonial:feature/docs-v3
Mar 25, 2024
Merged
Migrate documentation to mkdocs #1810
FasterSpeeding
merged 50 commits into
hikari-py:master
from
hypergonial:feature/docs-v3
Mar 25, 2024
Commits on Jan 20, 2024
-
Configuration menu - View commit details
-
Copy full SHA for 9405f96 - Browse repository at this point
Copy the full SHA 9405f96View commit details -
Configuration menu - View commit details
-
Copy full SHA for 98ab59e - Browse repository at this point
Copy the full SHA 98ab59eView commit details -
Configuration menu - View commit details
-
Copy full SHA for f6152a7 - Browse repository at this point
Copy the full SHA f6152a7View commit details -
Configuration menu - View commit details
-
Copy full SHA for b9e1399 - Browse repository at this point
Copy the full SHA b9e1399View commit details -
Configuration menu - View commit details
-
Copy full SHA for b0c937b - Browse repository at this point
Copy the full SHA b0c937bView commit details -
Configuration menu - View commit details
-
Copy full SHA for 23a9f3f - Browse repository at this point
Copy the full SHA 23a9f3fView commit details
Commits on Jan 21, 2024
-
Configuration menu - View commit details
-
Copy full SHA for fda74d1 - Browse repository at this point
Copy the full SHA fda74d1View commit details -
Configuration menu - View commit details
-
Copy full SHA for 6ffdec8 - Browse repository at this point
Copy the full SHA 6ffdec8View commit details -
Configuration menu - View commit details
-
Copy full SHA for 9b62648 - Browse repository at this point
Copy the full SHA 9b62648View commit details -
Configuration menu - View commit details
-
Copy full SHA for e6a2474 - Browse repository at this point
Copy the full SHA e6a2474View commit details -
Configuration menu - View commit details
-
Copy full SHA for 7bde864 - Browse repository at this point
Copy the full SHA 7bde864View commit details -
Configuration menu - View commit details
-
Copy full SHA for 5fa08ac - Browse repository at this point
Copy the full SHA 5fa08acView commit details -
Configuration menu - View commit details
-
Copy full SHA for 8ba5529 - Browse repository at this point
Copy the full SHA 8ba5529View commit details -
- Just to avoid this being pushed anywhere and ruining our gh-pages branch
Configuration menu - View commit details
-
Copy full SHA for 43adf8d - Browse repository at this point
Copy the full SHA 43adf8dView commit details -
Configuration menu - View commit details
-
Copy full SHA for b7361a1 - Browse repository at this point
Copy the full SHA b7361a1View commit details -
Configuration menu - View commit details
-
Copy full SHA for d3834a4 - Browse repository at this point
Copy the full SHA d3834a4View commit details -
Configuration menu - View commit details
-
Copy full SHA for ff54c8c - Browse repository at this point
Copy the full SHA ff54c8cView commit details -
Configuration menu - View commit details
-
Copy full SHA for 629bac8 - Browse repository at this point
Copy the full SHA 629bac8View commit details -
It seems like we only use it in the internal module, which we are no longer documenting
Configuration menu - View commit details
-
Copy full SHA for 0ed3dec - Browse repository at this point
Copy the full SHA 0ed3decView commit details -
Configuration menu - View commit details
-
Copy full SHA for df4e1d1 - Browse repository at this point
Copy the full SHA df4e1d1View commit details -
- For some reason, it doesn't work on chrome for large pages
Configuration menu - View commit details
-
Copy full SHA for 6b8aa16 - Browse repository at this point
Copy the full SHA 6b8aa16View commit details -
Configuration menu - View commit details
-
Copy full SHA for 849806e - Browse repository at this point
Copy the full SHA 849806eView commit details -
Configuration menu - View commit details
-
Copy full SHA for a00b1cc - Browse repository at this point
Copy the full SHA a00b1ccView commit details -
Configuration menu - View commit details
-
Copy full SHA for c0ccd6c - Browse repository at this point
Copy the full SHA c0ccd6cView commit details -
Revert "Remove top level hikari reference page"
This reverts commit c0ccd6c.
Configuration menu - View commit details
-
Copy full SHA for 3e0aaf1 - Browse repository at this point
Copy the full SHA 3e0aaf1View commit details -
Configuration menu - View commit details
-
Copy full SHA for e5214b6 - Browse repository at this point
Copy the full SHA e5214b6View commit details -
Configuration menu - View commit details
-
Copy full SHA for 564b506 - Browse repository at this point
Copy the full SHA 564b506View commit details -
Configuration menu - View commit details
-
Copy full SHA for dc20503 - Browse repository at this point
Copy the full SHA dc20503View commit details -
Configuration menu - View commit details
-
Copy full SHA for fe94b30 - Browse repository at this point
Copy the full SHA fe94b30View commit details -
- Regex used: `^ \.\. code-block:: python\n\n(( .+|\n)+)\n^ """` - Replacement string: ` ```py\n$1\n ```\n """`
Configuration menu - View commit details
-
Copy full SHA for 5b47b30 - Browse repository at this point
Copy the full SHA 5b47b30View commit details -
- Regex used: `^ \.\. code-block:: python\n\n(( .+|\n)*)\n\n` - Replacement string: ` ```py\n$1\n ```\n\n`
Configuration menu - View commit details
-
Copy full SHA for 0d96cb8 - Browse repository at this point
Copy the full SHA 0d96cb8View commit details -
- Regex used: `^ \.\. code-block:: python\n\n(( .+|\n)*)\n\n` - Replacement string: ` ```py\n$1\n ```\n\n`
Configuration menu - View commit details
-
Copy full SHA for efe4c3b - Browse repository at this point
Copy the full SHA efe4c3bView commit details -
Configuration menu - View commit details
-
Copy full SHA for db93fd4 - Browse repository at this point
Copy the full SHA db93fd4View commit details -
- Regex used: `\.\. (.+)::` - Replacement string: `!!! $1`
Configuration menu - View commit details
-
Copy full SHA for 992466d - Browse repository at this point
Copy the full SHA 992466dView commit details -
Configuration menu - View commit details
-
Copy full SHA for b13df05 - Browse repository at this point
Copy the full SHA b13df05View commit details -
Configuration menu - View commit details
-
Copy full SHA for 547ad2b - Browse repository at this point
Copy the full SHA 547ad2bView commit details -
Configuration menu - View commit details
-
Copy full SHA for 67fb222 - Browse repository at this point
Copy the full SHA 67fb222View commit details
Commits on Jan 22, 2024
-
Configuration menu - View commit details
-
Copy full SHA for 7f1d88b - Browse repository at this point
Copy the full SHA 7f1d88bView commit details
Commits on Jan 24, 2024
-
Configuration menu - View commit details
-
Copy full SHA for 0489ca6 - Browse repository at this point
Copy the full SHA 0489ca6View commit details
Commits on Jan 26, 2024
-
Configuration menu - View commit details
-
Copy full SHA for 0bb2c1d - Browse repository at this point
Copy the full SHA 0bb2c1dView commit details -
Configuration menu - View commit details
-
Copy full SHA for a28862b - Browse repository at this point
Copy the full SHA a28862bView commit details
Commits on Feb 25, 2024
-
Configuration menu - View commit details
-
Copy full SHA for 688f3bb - Browse repository at this point
Copy the full SHA 688f3bbView commit details -
Configuration menu - View commit details
-
Copy full SHA for 789096d - Browse repository at this point
Copy the full SHA 789096dView commit details -
Configuration menu - View commit details
-
Copy full SHA for a2e0b77 - Browse repository at this point
Copy the full SHA a2e0b77View commit details -
Somehow managed to break tests in a documentation PR :))
Configuration menu - View commit details
-
Copy full SHA for be9b5b1 - Browse repository at this point
Copy the full SHA be9b5b1View commit details -
Configuration menu - View commit details
-
Copy full SHA for 9193637 - Browse repository at this point
Copy the full SHA 9193637View commit details -
Configuration menu - View commit details
-
Copy full SHA for 6091ca1 - Browse repository at this point
Copy the full SHA 6091ca1View commit details
Commits on Feb 26, 2024
-
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/
Configuration menu - View commit details
-
Copy full SHA for 98a9b44 - Browse repository at this point
Copy the full SHA 98a9b44View commit details
Commits on Mar 2, 2024
-
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
Configuration menu - View commit details
-
Copy full SHA for 0878d3d - Browse repository at this point
Copy the full SHA 0878d3dView commit details
Commits on Mar 19, 2024
-
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
Configuration menu - View commit details
-
Copy full SHA for 815e471 - Browse repository at this point
Copy the full SHA 815e471View commit details
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.