René's URL Explorer Experiment


Title: Implement `usethis tool mkdocs` by nathanjmcdougall · Pull Request #823 · usethis-python/usethis-python · GitHub

Open Graph Title: Implement `usethis tool mkdocs` by nathanjmcdougall · Pull Request #823 · usethis-python/usethis-python

X Title: Implement `usethis tool mkdocs` by nathanjmcdougall · Pull Request #823 · usethis-python/usethis-python

Description: Automatically manage Python tooling and configuration: linters, formatters, and more. A CLI for declaratively configuring your Python projects following best practices. - Implement `usethis tool mkdocs` by nathanjmcdougall · Pull Request #823 · usethis-python/usethis-python

Opengraph URL: https://github.com/usethis-python/usethis-python/pull/823

X: @github

direct link

Domain: github.com

route-pattern/_view_fragments/voltron/pull_requests/show/:user_id/:repository/:id/pull_request_layout(.:format)
route-controllervoltron_pull_requests_fragments
route-actionpull_request_layout
fetch-noncev2:c9cedfb7-9efa-5a2e-30f5-83e6aad29c46
current-catalog-service-hashae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b
request-id9BC8:121006:F521:144C0:6A4D27B8
html-safe-noncee6a51f43c2664f5b541096c884850c7934ceedeaba26a0182041183f4a1dafb3
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5QkM4OjEyMTAwNjpGNTIxOjE0NEMwOjZBNEQyN0I4IiwidmlzaXRvcl9pZCI6IjE0NjUxNTUwNDE3MTUxMDM2NzIiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ==
visitor-hmac5f30e53bc12210865bebd327d21a742d15347d571d4647e882131bbd826e59dc
hovercard-subject-tagpull_request:2625797022
github-keyboard-shortcutsrepository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/pull_requests_fragments/pull_request_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/voltron/pull_requests/show/usethis-python/usethis-python/823/pull_request_layout
twitter:imagehttps://opengraph.githubassets.com/549564bd71daf7ee82507237db7c20063f61212dee0f22319bcb32e8fc3a00de/usethis-python/usethis-python/pull/823
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/549564bd71daf7ee82507237db7c20063f61212dee0f22319bcb32e8fc3a00de/usethis-python/usethis-python/pull/823
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernamenathanjmcdougall
hostnamegithub.com
expected-hostnamegithub.com
None92571a8944142227b7e19cd10918b1ddd06e5066c1ad5bc7e4769cf6140a87e6
turbo-cache-controlno-cache
go-importgithub.com/usethis-python/usethis-python git https://github.com/usethis-python/usethis-python.git
octolytics-dimension-user_id216362695
octolytics-dimension-user_loginusethis-python
octolytics-dimension-repository_id842189705
octolytics-dimension-repository_nwousethis-python/usethis-python
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id842189705
octolytics-dimension-repository_network_root_nwousethis-python/usethis-python
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release93f17a978ee60bc4668e1d7b90e6bd2d622261fd
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://github.com/usethis-python/usethis-python/pull/823#start-of-content
https://github.com/
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fusethis-python%2Fusethis-python%2Fpull%2F823
GitHub CopilotWrite better code with AIhttps://github.com/features/copilot
GitHub Copilot appDirect agents from issue to mergehttps://github.com/features/ai/github-app
MCP RegistryNewIntegrate external toolshttps://github.com/mcp
ActionsAutomate any workflowhttps://github.com/features/actions
CodespacesInstant dev environmentshttps://github.com/features/codespaces
IssuesPlan and track workhttps://github.com/features/issues
Code ReviewManage code changeshttps://github.com/features/code-review
GitHub Advanced SecurityFind and fix vulnerabilitieshttps://github.com/security/advanced-security
Code securitySecure your code as you buildhttps://github.com/security/advanced-security/code-security
Secret protectionStop leaks before they starthttps://github.com/security/advanced-security/secret-protection
Why GitHubhttps://github.com/why-github
Documentationhttps://docs.github.com
Bloghttps://github.blog
Changeloghttps://github.blog/changelog
Marketplacehttps://github.com/marketplace
View all featureshttps://github.com/features
Enterpriseshttps://github.com/enterprise
Small and medium teamshttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
App Modernizationhttps://github.com/solutions/use-case/app-modernization
DevSecOpshttps://github.com/solutions/use-case/devsecops
DevOpshttps://github.com/solutions/use-case/devops
CI/CDhttps://github.com/solutions/use-case/ci-cd
View all use caseshttps://github.com/solutions/use-case
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
View all industrieshttps://github.com/solutions/industry
View all solutionshttps://github.com/solutions
AIhttps://github.com/resources/articles?topic=ai
Software Developmenthttps://github.com/resources/articles?topic=software-development
DevOpshttps://github.com/resources/articles?topic=devops
Securityhttps://github.com/resources/articles?topic=security
View all topicshttps://github.com/resources/articles
Customer storieshttps://github.com/customer-stories
Events & webinarshttps://github.com/resources/events
Ebooks & reportshttps://github.com/resources/whitepapers
Business insightshttps://github.com/solutions/executive-insights
GitHub Skillshttps://skills.github.com
Documentationhttps://docs.github.com
Customer supporthttps://support.github.com
Community forumhttps://github.com/orgs/community/discussions
Trust centerhttps://github.com/trust-center
Partnershttps://github.com/partners
View all resourceshttps://github.com/resources
GitHub SponsorsFund open source developershttps://github.com/sponsors
Security Labhttps://securitylab.github.com
Maintainer Communityhttps://maintainers.github.com
Acceleratorhttps://github.com/accelerator
GitHub Starshttps://stars.github.com
Archive Programhttps://archiveprogram.github.com
Topicshttps://github.com/topics
Trendinghttps://github.com/trending
Collectionshttps://github.com/collections
Enterprise platformAI-powered developer platformhttps://github.com/enterprise
GitHub Advanced SecurityEnterprise-grade security featureshttps://github.com/security/advanced-security
Copilot for BusinessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/premium-support
Pricinghttps://github.com/pricing
Search syntax tipshttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
documentationhttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fusethis-python%2Fusethis-python%2Fpull%2F823
Sign up https://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fpull_requests_fragments%2Fpull_request_layout&source=header-repo&source_repo=usethis-python%2Fusethis-python
Reloadhttps://github.com/usethis-python/usethis-python/pull/823
Reloadhttps://github.com/usethis-python/usethis-python/pull/823
Reloadhttps://github.com/usethis-python/usethis-python/pull/823
Please reload this pagehttps://github.com/usethis-python/usethis-python/pull/823
usethis-python https://github.com/usethis-python
usethis-pythonhttps://github.com/usethis-python/usethis-python
Notifications https://github.com/login?return_to=%2Fusethis-python%2Fusethis-python
Fork 5 https://github.com/login?return_to=%2Fusethis-python%2Fusethis-python
Star 19 https://github.com/login?return_to=%2Fusethis-python%2Fusethis-python
Code https://github.com/usethis-python/usethis-python
Issues 163 https://github.com/usethis-python/usethis-python/issues
Pull requests 4 https://github.com/usethis-python/usethis-python/pulls
Actions https://github.com/usethis-python/usethis-python/actions
Security and quality 0 https://github.com/usethis-python/usethis-python/security
Insights https://github.com/usethis-python/usethis-python/pulse
Code https://github.com/usethis-python/usethis-python
Issues https://github.com/usethis-python/usethis-python/issues
Pull requests https://github.com/usethis-python/usethis-python/pulls
Actions https://github.com/usethis-python/usethis-python/actions
Security and quality https://github.com/usethis-python/usethis-python/security
Insights https://github.com/usethis-python/usethis-python/pulse
nathanjmcdougallhttps://github.com/nathanjmcdougall
mainhttps://github.com/usethis-python/usethis-python/tree/main
188-implement-usethis-tool-mkdocshttps://github.com/usethis-python/usethis-python/tree/188-implement-usethis-tool-mkdocs
Conversationhttps://github.com/usethis-python/usethis-python/pull/823
Commits18 (18)https://github.com/usethis-python/usethis-python/pull/823/commits
Checkshttps://github.com/usethis-python/usethis-python/pull/823/checks
Files changedhttps://github.com/usethis-python/usethis-python/pull/823/files
Implement usethis tool mkdocshttps://github.com/usethis-python/usethis-python/pull/823#top
nathanjmcdougallhttps://github.com/nathanjmcdougall
mainhttps://github.com/usethis-python/usethis-python/tree/main
188-implement-usethis-tool-mkdocshttps://github.com/usethis-python/usethis-python/tree/188-implement-usethis-tool-mkdocs
https://github.com/nathanjmcdougall
nathanjmcdougallhttps://github.com/nathanjmcdougall
Jun 28, 2025https://github.com/usethis-python/usethis-python/pull/823#issue-3184537999
Please reload this pagehttps://github.com/usethis-python/usethis-python/pull/823
https://github.com/nathanjmcdougall
Add scaffolding for implementation of usethis tool mkdocshttps://github.com/usethis-python/usethis-python/pull/823/commits/ba8692e5eb41eb75eacd99a81e50713e78267789
ba8692ehttps://github.com/usethis-python/usethis-python/pull/823/commits/ba8692e5eb41eb75eacd99a81e50713e78267789
https://github.com/nathanjmcdougall
nathanjmcdougallhttps://github.com/nathanjmcdougall
Jun 28, 2025https://github.com/usethis-python/usethis-python/pull/823#event-18367125928
Implement usethis tool mkdocs #188 https://github.com/usethis-python/usethis-python/issues/188
nathanjmcdougallhttps://github.com/nathanjmcdougall
June 30, 2025 17:20https://github.com/usethis-python/usethis-python/pull/823#commits-pushed-bc45b5c
https://github.com/nathanjmcdougall
Add mkdocs to ALL_TOOL_COMMANDShttps://github.com/usethis-python/usethis-python/pull/823/commits/bc45b5c3eddb1e0bd1ae9f5e50ab20eb4e5fa19f
bc45b5chttps://github.com/usethis-python/usethis-python/pull/823/commits/bc45b5c3eddb1e0bd1ae9f5e50ab20eb4e5fa19f
https://github.com/nathanjmcdougall
Add basic implementation of MkDocsTool classhttps://github.com/usethis-python/usethis-python/pull/823/commits/d4f4c6956475c1365dfec510685ac79b4f6184d3
d4f4c69https://github.com/usethis-python/usethis-python/pull/823/commits/d4f4c6956475c1365dfec510685ac79b4f6184d3
https://github.com/nathanjmcdougall
Add MkDocsTool to ALL_TOOLS and SupportedToolTypehttps://github.com/usethis-python/usethis-python/pull/823/commits/67d08a99e88b4e1bc2c68659221dfd6c65e7980c
67d08a9https://github.com/usethis-python/usethis-python/pull/823/commits/67d08a99e88b4e1bc2c68659221dfd6c65e7980c
https://github.com/nathanjmcdougall
Add scaffolding for YAMLFileManagerhttps://github.com/usethis-python/usethis-python/pull/823/commits/25aa5097b682e4833e1f812f39230656a2d2cf20
25aa509https://github.com/usethis-python/usethis-python/pull/823/commits/25aa5097b682e4833e1f812f39230656a2d2cf20
https://github.com/nathanjmcdougall
Merge branch 'main' into 188-implement-usethis-tool-mkdocshttps://github.com/usethis-python/usethis-python/pull/823/commits/aa42592405a28674aa5ffcc8dbada6152f9efaa5
aa42592https://github.com/usethis-python/usethis-python/pull/823/commits/aa42592405a28674aa5ffcc8dbada6152f9efaa5
https://github.com/nathanjmcdougall
Merge branch 'main' into 188-implement-usethis-tool-mkdocshttps://github.com/usethis-python/usethis-python/pull/823/commits/feab37f19f602f95e2f5e864cbe7d112d2bffcd4
feab37fhttps://github.com/usethis-python/usethis-python/pull/823/commits/feab37f19f602f95e2f5e864cbe7d112d2bffcd4
https://github.com/nathanjmcdougall
Add use_mkdocs to use_toolhttps://github.com/usethis-python/usethis-python/pull/823/commits/ad801b2365d4812b2e0b96da72a90e7e92a1110e
ad801b2https://github.com/usethis-python/usethis-python/pull/823/commits/ad801b2365d4812b2e0b96da72a90e7e92a1110e
https://github.com/nathanjmcdougall
Implement get_config_spec for MkDocsToolhttps://github.com/usethis-python/usethis-python/pull/823/commits/97b5f5d55b5552e04e87db12783545984c1bd8a2
97b5f5dhttps://github.com/usethis-python/usethis-python/pull/823/commits/97b5f5d55b5552e04e87db12783545984c1bd8a2
https://github.com/nathanjmcdougall
Add MkDocsTool to OTHER_TOOLS list for pyproject.tomlhttps://github.com/usethis-python/usethis-python/pull/823/commits/0e0a59d42274c7e86c1b07395499f79b9bf3ff09
0e0a59dhttps://github.com/usethis-python/usethis-python/pull/823/commits/0e0a59d42274c7e86c1b07395499f79b9bf3ff09
https://github.com/nathanjmcdougall
Update usage table for usethis listhttps://github.com/usethis-python/usethis-python/pull/823/commits/b649a0234b1353f31a713642538b83069b8137b4
b649a02https://github.com/usethis-python/usethis-python/pull/823/commits/b649a0234b1353f31a713642538b83069b8137b4
https://github.com/apps/codecov
codecovhttps://github.com/apps/codecov
Jul 13, 2025https://github.com/usethis-python/usethis-python/pull/823#issuecomment-3067384981
Please reload this pagehttps://github.com/usethis-python/usethis-python/pull/823
Codecovhttps://app.codecov.io/gh/usethis-python/usethis-python/pull/823?dropdown=coverage&src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=usethis-python
Let us know!https://github.com/codecov/feedback/issues/255
Please reload this pagehttps://github.com/usethis-python/usethis-python/pull/823
https://github.com/apps/codspeed-hq
codspeed-hqhttps://github.com/apps/codspeed-hq
Jul 13, 2025https://github.com/usethis-python/usethis-python/pull/823#issuecomment-3067385929
Please reload this pagehttps://github.com/usethis-python/usethis-python/pull/823
CodSpeed Instrumentation Performance Reporthttps://codspeed.io/usethis-python/usethis-python/branches/188-implement-usethis-tool-mkdocs?runnerMode=Instrumentation
#823https://github.com/usethis-python/usethis-python/pull/823
08620efhttps://github.com/usethis-python/usethis-python/commit/08620ef55e668abf04bd930507637f830659ae0d
c694f81https://github.com/usethis-python/usethis-python/commit/c694f81e06ddcccb5ee229a2ab90531321550dec
Please reload this pagehttps://github.com/usethis-python/usethis-python/pull/823
https://github.com/nathanjmcdougall
nathanjmcdougallhttps://github.com/nathanjmcdougall
Jul 13, 2025https://github.com/usethis-python/usethis-python/pull/823#issuecomment-3067386063
Please reload this pagehttps://github.com/usethis-python/usethis-python/pull/823
nathanjmcdougallhttps://github.com/nathanjmcdougall
July 15, 2025 18:10https://github.com/usethis-python/usethis-python/pull/823#commits-pushed-9ec1f0e
https://github.com/nathanjmcdougall
Implement use_mkdocs(..., remove=True)https://github.com/usethis-python/usethis-python/pull/823/commits/9ec1f0ed8a5d5dfea2efa32dbad5bff0b87fef97
9ec1f0ehttps://github.com/usethis-python/usethis-python/pull/823/commits/9ec1f0ed8a5d5dfea2efa32dbad5bff0b87fef97
https://github.com/nathanjmcdougall
Add tests for use_mkdocs(..., remove=True)https://github.com/usethis-python/usethis-python/pull/823/commits/10f4cfd9161f251486f235137d196d5103f92374
10f4cfdhttps://github.com/usethis-python/usethis-python/pull/823/commits/10f4cfd9161f251486f235137d196d5103f92374
https://github.com/nathanjmcdougall
Add tests for src\usethis\_integrations\mkdocs\core.py and `use_mkd…https://github.com/usethis-python/usethis-python/pull/823/commits/55a0db490f2e6a3b62ee4ed8017e0905b70021dd
55a0db4https://github.com/usethis-python/usethis-python/pull/823/commits/55a0db490f2e6a3b62ee4ed8017e0905b70021dd
https://github.com/nathanjmcdougall
Add tests for MkDocsTool.print_how_to_usehttps://github.com/usethis-python/usethis-python/pull/823/commits/4e49e921f6869723fc86f92d7baa712f3209196a
4e49e92https://github.com/usethis-python/usethis-python/pull/823/commits/4e49e921f6869723fc86f92d7baa712f3209196a
https://github.com/nathanjmcdougall
nathanjmcdougallhttps://github.com/nathanjmcdougall
July 15, 2025 10:20https://github.com/usethis-python/usethis-python/pull/823#event-18635209986
https://github.com/nathanjmcdougall
nathanjmcdougallhttps://github.com/nathanjmcdougall
Copilothttps://github.com/apps/copilot-pull-request-reviewer
July 15, 2025 10:20https://github.com/usethis-python/usethis-python/pull/823#event-18635211535
https://github.com/apps/copilot-pull-request-reviewer
Copilothttps://github.com/apps/copilot-pull-request-reviewer
Jul 15, 2025 https://github.com/usethis-python/usethis-python/pull/823#pullrequestreview-3019686131
View reviewed changes https://github.com/usethis-python/usethis-python/pull/823/files/4e49e921f6869723fc86f92d7baa712f3209196a
Copilothttps://github.com/apps/copilot-pull-request-reviewer
https://github.com/usethis-python/usethis-python/pull/823#pullrequestreview-3019686131
Learn morehttps://docs.github.com/articles/managing-disruptive-comments/#hiding-a-comment
Please reload this pagehttps://github.com/usethis-python/usethis-python/pull/823
src/usethis/_tool/impl/mkdocs.pyhttps://github.com/usethis-python/usethis-python/pull/823/files/4e49e921f6869723fc86f92d7baa712f3209196a#diff-882650668f454fa2bf2afafb8e50bd0f82c185ad1577cc5870694396d0c7dee0
Please reload this pagehttps://github.com/usethis-python/usethis-python/pull/823
nathanjmcdougallhttps://github.com/nathanjmcdougall
July 15, 2025 22:22https://github.com/usethis-python/usethis-python/pull/823#commits-pushed-8ef5bd8
https://github.com/nathanjmcdougall
https://github.com/apps/copilot-pull-request-reviewer
Fix typo in comment in src/usethis/_tool/impl/mkdocs.pyhttps://github.com/usethis-python/usethis-python/pull/823/commits/8ef5bd8e9844aa68da854436c101553bd837ca88
8ef5bd8https://github.com/usethis-python/usethis-python/pull/823/commits/8ef5bd8e9844aa68da854436c101553bd837ca88
https://github.com/nathanjmcdougall
Update README to document usethis mkdocshttps://github.com/usethis-python/usethis-python/pull/823/commits/68d6d3ff2ac1dfabffa7bc958a913be25d881d8c
68d6d3fhttps://github.com/usethis-python/usethis-python/pull/823/commits/68d6d3ff2ac1dfabffa7bc958a913be25d881d8c
https://github.com/nathanjmcdougall
Merge branch '188-implement-usethis-tool-mkdocs' ofhttps://github.com/usethis-python/usethis-python/pull/823/commits/08620ef55e668abf04bd930507637f830659ae0d
https://github.co…https://github.com/nathanjmcdougall/usethis-python
08620efhttps://github.com/usethis-python/usethis-python/pull/823/commits/08620ef55e668abf04bd930507637f830659ae0d
…m/nathanjmcdougall/usethis-pythonhttps://github.com/nathanjmcdougall/usethis-python
https://github.com/nathanjmcdougall
nathanjmcdougallhttps://github.com/nathanjmcdougall
4731365https://github.com/usethis-python/usethis-python/commit/47313656821dd7ec0016bc4a283625d45cfa715f
Jul 15, 2025https://github.com/usethis-python/usethis-python/pull/823#event-18635595973
Please reload this pagehttps://github.com/usethis-python/usethis-python/pull/823
https://github.com/nathanjmcdougall
nathanjmcdougallhttps://github.com/nathanjmcdougall
July 15, 2025 10:44https://github.com/usethis-python/usethis-python/pull/823#event-18635596411
https://github.com/nathanjmcdougall
nathanjmcdougallhttps://github.com/nathanjmcdougall
Jul 15, 2025 https://github.com/usethis-python/usethis-python/pull/823#ref-issue-3231953181
Document how to add a new tool for contributors #856 https://github.com/usethis-python/usethis-python/issues/856
https://github.co/hiddenchars
https://github.com/usethis-python/usethis-python/pull/{{ revealButtonHref }}
Sign up for freehttps://github.com/join?source=comment-repo
Sign in to commenthttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fusethis-python%2Fusethis-python%2Fpull%2F823
Copilot code review https://github.com/apps/copilot-pull-request-reviewer
Copilot https://github.com/apps/copilot-pull-request-reviewer
https://github.com/usethis-python/usethis-python/pull/823/files/4e49e921f6869723fc86f92d7baa712f3209196a
Implement usethis tool mkdocs https://github.com/usethis-python/usethis-python/issues/188
Please reload this pagehttps://github.com/usethis-python/usethis-python/pull/823
https://github.com/nathanjmcdougall
https://github.com/apps/copilot-pull-request-reviewer
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width

URLs of crawlers that visited me.