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
Domain: patch-diff.githubusercontent.com
{"@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-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:ba3e7424-4897-6e8e-936d-7f5f5799e139 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | EDFA:1E5F68:5EECF36:7C0F6DB:696D6399 |
| html-safe-nonce | 0d5ea1fb7f1caa4bffba4b9fd1848b625ab7e229b61a8cc040859956f4d4e5c2 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJFREZBOjFFNUY2ODo1RUVDRjM2OjdDMEY2REI6Njk2RDYzOTkiLCJ2aXNpdG9yX2lkIjoiMzMxMjA1ODY1NDc4MDEyMjAwOSIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 5b905052f854fe3012d5cf7daede45a15443b0c7a3d23a1fb351c12afc96aeba |
| hovercard-subject-tag | issue:2612681755 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/mkdocstrings/python/199/issue_layout |
| twitter:image | https://opengraph.githubassets.com/faa40adf05860a513405e455e80e5f86a77b30029ea831470e74792e908dc34d/mkdocstrings/python/issues/199 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/faa40adf05860a513405e455e80e5f86a77b30029ea831470e74792e908dc34d/mkdocstrings/python/issues/199 |
| og:image:alt | 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 ... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | pawamoy |
| hostname | github.com |
| expected-hostname | github.com |
| None | 0944e430045f4fb5f7bd103e0660080acfe593174063212555773ca41c144a14 |
| turbo-cache-control | no-preview |
| go-import | github.com/mkdocstrings/python git https://github.com/mkdocstrings/python.git |
| octolytics-dimension-user_id | 75664361 |
| octolytics-dimension-user_login | mkdocstrings |
| octolytics-dimension-repository_id | 422878404 |
| octolytics-dimension-repository_nwo | mkdocstrings/python |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 422878404 |
| octolytics-dimension-repository_network_root_nwo | mkdocstrings/python |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 66b6e773801d28660016072069017cfcc851f54b |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width