René's URL Explorer Experiment


Title: docs: Documentation updates · Issue #199 · mkdocstrings/python · GitHub

Open Graph Title: docs: Documentation updates · Issue #199 · mkdocstrings/python

X Title: docs: Documentation updates · Issue #199 · mkdocstrings/python

Description: Meta issue for tracking documentation improvements. limitation with footnotes, references (see mkdocstrings/pytkdocs#26) how to document enumeration values recommendation: giving a heading to each object, even modules suggest https://git...

Open Graph Description: Meta issue for tracking documentation improvements. limitation with footnotes, references (see mkdocstrings/pytkdocs#26) how to document enumeration values recommendation: giving a heading to each ...

X Description: Meta issue for tracking documentation improvements. limitation with footnotes, references (see mkdocstrings/pytkdocs#26) how to document enumeration values recommendation: giving a heading to each ...

Opengraph URL: https://github.com/mkdocstrings/python/issues/199

X: @github

direct link

Domain: patch-diff.githubusercontent.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"docs: Documentation updates","articleBody":"Meta issue for tracking documentation improvements.\n\n- [x] limitation with footnotes, references (see https://github.com/mkdocstrings/pytkdocs/issues/26)\n- [ ] how to document enumeration values\n- [x] recommendation: giving a heading to each object, even modules\n- [x] suggest https://github.com/analog-garage/mkdocstrings-python-xref as alternate handler with relative cross-refs\n- [x] suggest https://github.com/jcayers20/mkdocs-autoapi for automatic generation of pages (see https://github.com/mkdocstrings/mkdocstrings/issues/389)\n- [ ] [see all issues with docs label](https://github.com/issues?q=is%3Aissue+user%3Apawamoy+user%3Amkdocstrings+archived%3Afalse+sort%3Areactions-%2B1-desc+label%3Adocs)\n- [x] Make it more prominent that show_submodules is needed for recursivley documenting submodules (see https://github.com/mkdocstrings/python/issues/146)","author":{"url":"https://github.com/pawamoy","@type":"Person","name":"pawamoy"},"datePublished":"2024-10-24T22:38:02.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":0},"url":"https://github.com/199/python/issues/199"}

route-pattern/_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format)
route-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:ba3e7424-4897-6e8e-936d-7f5f5799e139
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-idEDFA:1E5F68:5EECF36:7C0F6DB:696D6399
html-safe-nonce0d5ea1fb7f1caa4bffba4b9fd1848b625ab7e229b61a8cc040859956f4d4e5c2
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJFREZBOjFFNUY2ODo1RUVDRjM2OjdDMEY2REI6Njk2RDYzOTkiLCJ2aXNpdG9yX2lkIjoiMzMxMjA1ODY1NDc4MDEyMjAwOSIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9
visitor-hmac5b905052f854fe3012d5cf7daede45a15443b0c7a3d23a1fb351c12afc96aeba
hovercard-subject-tagissue:2612681755
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/mkdocstrings/python/199/issue_layout
twitter:imagehttps://opengraph.githubassets.com/faa40adf05860a513405e455e80e5f86a77b30029ea831470e74792e908dc34d/mkdocstrings/python/issues/199
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/faa40adf05860a513405e455e80e5f86a77b30029ea831470e74792e908dc34d/mkdocstrings/python/issues/199
og:image:altMeta issue for tracking documentation improvements. limitation with footnotes, references (see mkdocstrings/pytkdocs#26) how to document enumeration values recommendation: giving a heading to each ...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernamepawamoy
hostnamegithub.com
expected-hostnamegithub.com
None0944e430045f4fb5f7bd103e0660080acfe593174063212555773ca41c144a14
turbo-cache-controlno-preview
go-importgithub.com/mkdocstrings/python git https://github.com/mkdocstrings/python.git
octolytics-dimension-user_id75664361
octolytics-dimension-user_loginmkdocstrings
octolytics-dimension-repository_id422878404
octolytics-dimension-repository_nwomkdocstrings/python
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id422878404
octolytics-dimension-repository_network_root_nwomkdocstrings/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
release66b6e773801d28660016072069017cfcc851f54b
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://patch-diff.githubusercontent.com/mkdocstrings/python/issues/199#start-of-content
https://patch-diff.githubusercontent.com/
Sign in https://patch-diff.githubusercontent.com/login?return_to=https%3A%2F%2Fgithub.com%2Fmkdocstrings%2Fpython%2Fissues%2F199
GitHub CopilotWrite better code with AIhttps://github.com/features/copilot
GitHub SparkBuild and deploy intelligent appshttps://github.com/features/spark
GitHub ModelsManage and compare promptshttps://github.com/features/models
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
GitHub SponsorsFund open source developershttps://github.com/sponsors
Security Labhttps://securitylab.github.com
Maintainer Communityhttps://maintainers.github.com
Acceleratorhttps://github.com/accelerator
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://patch-diff.githubusercontent.com/login?return_to=https%3A%2F%2Fgithub.com%2Fmkdocstrings%2Fpython%2Fissues%2F199
Sign up https://patch-diff.githubusercontent.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=mkdocstrings%2Fpython
Reloadhttps://patch-diff.githubusercontent.com/mkdocstrings/python/issues/199
Reloadhttps://patch-diff.githubusercontent.com/mkdocstrings/python/issues/199
Reloadhttps://patch-diff.githubusercontent.com/mkdocstrings/python/issues/199
mkdocstrings https://patch-diff.githubusercontent.com/mkdocstrings
pythonhttps://patch-diff.githubusercontent.com/mkdocstrings/python
Please reload this pagehttps://patch-diff.githubusercontent.com/mkdocstrings/python/issues/199
Notifications https://patch-diff.githubusercontent.com/login?return_to=%2Fmkdocstrings%2Fpython
Fork 52 https://patch-diff.githubusercontent.com/login?return_to=%2Fmkdocstrings%2Fpython
Star 259 https://patch-diff.githubusercontent.com/login?return_to=%2Fmkdocstrings%2Fpython
Code https://patch-diff.githubusercontent.com/mkdocstrings/python
Issues 10 https://patch-diff.githubusercontent.com/mkdocstrings/python/issues
Pull requests 0 https://patch-diff.githubusercontent.com/mkdocstrings/python/pulls
Discussions https://patch-diff.githubusercontent.com/mkdocstrings/python/discussions
Actions https://patch-diff.githubusercontent.com/mkdocstrings/python/actions
Security Uh oh! There was an error while loading. Please reload this page. https://patch-diff.githubusercontent.com/mkdocstrings/python/security
Please reload this pagehttps://patch-diff.githubusercontent.com/mkdocstrings/python/issues/199
Insights https://patch-diff.githubusercontent.com/mkdocstrings/python/pulse
Code https://patch-diff.githubusercontent.com/mkdocstrings/python
Issues https://patch-diff.githubusercontent.com/mkdocstrings/python/issues
Pull requests https://patch-diff.githubusercontent.com/mkdocstrings/python/pulls
Discussions https://patch-diff.githubusercontent.com/mkdocstrings/python/discussions
Actions https://patch-diff.githubusercontent.com/mkdocstrings/python/actions
Security https://patch-diff.githubusercontent.com/mkdocstrings/python/security
Insights https://patch-diff.githubusercontent.com/mkdocstrings/python/pulse
New issuehttps://patch-diff.githubusercontent.com/login?return_to=https://github.com/mkdocstrings/python/issues/199
New issuehttps://patch-diff.githubusercontent.com/login?return_to=https://github.com/mkdocstrings/python/issues/199
docs: Documentation updateshttps://patch-diff.githubusercontent.com/mkdocstrings/python/issues/199#top
https://patch-diff.githubusercontent.com/pawamoy
docsImprovements or additions to documentationhttps://github.com/mkdocstrings/python/issues?q=state%3Aopen%20label%3A%22docs%22
https://github.com/pawamoy
https://github.com/pawamoy
pawamoyhttps://github.com/pawamoy
on Oct 24, 2024https://github.com/mkdocstrings/python/issues/199#issue-2612681755
Document docstring parsing limitations pytkdocs#26https://github.com/mkdocstrings/pytkdocs/issues/26
https://github.com/analog-garage/mkdocstrings-python-xrefhttps://github.com/analog-garage/mkdocstrings-python-xref
https://github.com/jcayers20/mkdocs-autoapihttps://github.com/jcayers20/mkdocs-autoapi
Autodoc-like project layout mkdocstrings#389https://github.com/mkdocstrings/mkdocstrings/issues/389
see all issues with docs labelhttps://github.com/issues?q=is%3Aissue+user%3Apawamoy+user%3Amkdocstrings+archived%3Afalse+sort%3Areactions-%2B1-desc+label%3Adocs
docs: Make it more prominent that show_submodules is needed for recursivley documenting submodules #146https://github.com/mkdocstrings/python/issues/146
pawamoyhttps://patch-diff.githubusercontent.com/pawamoy
docsImprovements or additions to documentationhttps://github.com/mkdocstrings/python/issues?q=state%3Aopen%20label%3A%22docs%22
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.