Title: bug: Docstring Style Local Override Does Not Work · Issue #183 · mkdocstrings/python · GitHub
Open Graph Title: bug: Docstring Style Local Override Does Not Work · Issue #183 · mkdocstrings/python
X Title: bug: Docstring Style Local Override Does Not Work · Issue #183 · mkdocstrings/python
Description: Description of the bug Local override docstring_style for global configuration doesn't work. To Reproduce Declare in mkdocs.yaml: plugins: - mkdocstrings: enabled: true default_handler: python handlers: python: options: docstring_style: ...
Open Graph Description: Description of the bug Local override docstring_style for global configuration doesn't work. To Reproduce Declare in mkdocs.yaml: plugins: - mkdocstrings: enabled: true default_handler: python hand...
X Description: Description of the bug Local override docstring_style for global configuration doesn't work. To Reproduce Declare in mkdocs.yaml: plugins: - mkdocstrings: enabled: true default_handler: python ...
Opengraph URL: https://github.com/mkdocstrings/python/issues/183
X: @github
Domain: Github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"bug: Docstring Style Local Override Does Not Work","articleBody":"### Description of the bug\r\nLocal override `docstring_style` for global configuration doesn't work.\r\n\r\n### To Reproduce\r\n\r\nDeclare in mkdocs.yaml:\r\n\r\n```\r\nplugins:\r\n - mkdocstrings:\r\n enabled: true\r\n default_handler: python\r\n handlers:\r\n python:\r\n options:\r\n docstring_style: google\r\n```\r\n--\u003e\r\n\r\nInside `file.md` \r\n```\r\n::: path.to.module\r\n options:\r\n docstring_style: sphinx\r\n```\r\n\r\n### Full traceback\r\n\u003c!-- Please provide the full error message / traceback if any, by pasting it in the code block below.\r\n No screenshots! --\u003e\r\n\r\n\u003cdetails\u003e\u003csummary\u003eFull traceback\u003c/summary\u003e\r\n\r\n```python\r\nN/A\r\n```\r\n\r\n\u003c/details\u003e\r\n\r\n### Expected behavior\r\n\u003c!-- Please provide a clear and concise description of what you expected to happen. --\u003e\r\n\r\nOverride the default `google` style with the `sphinx` style for that one module.\r\n\r\n### Environment information\r\n\u003c!-- Please run the following command in your repository and paste its output below it,\r\n redacting sensitive information. --\u003e\r\n\r\n- __System__: Windows-10-10.0.19045-SP0\r\n- __Python__: cpython 3.10.11\r\n- __Environment variables__:\r\n- __Installed packages__:\r\n - `mkdocs` v1.6.0\r\n - `mkdocstrings` v0.26.0\r\n - `mkdocstrings-python` v1.10.5\r\n - `griffe` v0.47.0\r\n\r\n### Additional context\r\n\r\nI am using `path: ` to load the module and I'm using `mkdocs-monorepo-plugin`.\r\n","author":{"url":"https://github.com/triley13","@type":"Person","name":"triley13"},"datePublished":"2024-09-04T18:39:51.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":5},"url":"https://github.com/183/python/issues/183"}
| 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:08eb26d7-9b03-f628-2ef4-a1d7667453bb |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 8DCE:315C2A:1C203E4:261C9DA:6A62CD50 |
| html-safe-nonce | 5d46014301452fd892fa8d36ba5f0621288270715fd84dbd32dae5997c76168a |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4RENFOjMxNUMyQToxQzIwM0U0OjI2MUM5REE6NkE2MkNENTAiLCJ2aXNpdG9yX2lkIjoiNTEyMjQ3NjkyMDEyODMyNjk5MiIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 71535c8447645808f12bd91c153d3696894aa3fbbc62583505eb2dd27c228d85 |
| hovercard-subject-tag | issue:2506042175 |
| 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/183/issue_layout |
| twitter:image | https://opengraph.githubassets.com/0aeeb47c1be495dc47d06bb3143732b8ad46ac706ca1c067c51fc9e20728b504/mkdocstrings/python/issues/183 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/0aeeb47c1be495dc47d06bb3143732b8ad46ac706ca1c067c51fc9e20728b504/mkdocstrings/python/issues/183 |
| og:image:alt | Description of the bug Local override docstring_style for global configuration doesn't work. To Reproduce Declare in mkdocs.yaml: plugins: - mkdocstrings: enabled: true default_handler: python hand... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | triley13 |
| hostname | github.com |
| expected-hostname | github.com |
| None | df33b1b61ee7b9a0af988199bfc3503c9c1acafb1f1d40e1f140ea7c84f890dd |
| 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 | d41cd1bdb290013455c0ac430fa755621733f5eb |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width