{"action":"created","issue":{"url":"https://api.github.com/repos/sphinx-doc/sphinx/issues/4613","repository_url":"https://api.github.com/repos/sphinx-doc/sphinx","labels_url":"https://api.github.com/repos/sphinx-doc/sphinx/issues/4613/labels{/name}","comments_url":"https://api.github.com/repos/sphinx-doc/sphinx/issues/4613/comments","events_url":"https://api.github.com/repos/sphinx-doc/sphinx/issues/4613/events","html_url":"https://github.com/sphinx-doc/sphinx/pull/4613","id":296806556,"number":4613,"title":"[Napoleon] Implement missing napoleon admonitions","user":{"login":"althonos","id":8660647,"avatar_url":"https://avatars3.githubusercontent.com/u/8660647?v=4","gravatar_id":"","url":"https://api.github.com/users/althonos","html_url":"https://github.com/althonos","followers_url":"https://api.github.com/users/althonos/followers","following_url":"https://api.github.com/users/althonos/following{/other_user}","gists_url":"https://api.github.com/users/althonos/gists{/gist_id}","starred_url":"https://api.github.com/users/althonos/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/althonos/subscriptions","organizations_url":"https://api.github.com/users/althonos/orgs","repos_url":"https://api.github.com/users/althonos/repos","events_url":"https://api.github.com/users/althonos/events{/privacy}","received_events_url":"https://api.github.com/users/althonos/received_events","type":"User","site_admin":false},"labels":[],"state":"closed","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":1,"created_at":"2018-02-13T16:43:07Z","updated_at":"2018-02-13T17:06:05Z","closed_at":"2018-02-13T17:03:52Z","author_association":"CONTRIBUTOR","pull_request":{"url":"https://api.github.com/repos/sphinx-doc/sphinx/pulls/4613","html_url":"https://github.com/sphinx-doc/sphinx/pull/4613","diff_url":"https://github.com/sphinx-doc/sphinx/pull/4613.diff","patch_url":"https://github.com/sphinx-doc/sphinx/pull/4613.patch"},"body":"Subject: **[Napoleon] implement missing Sphinx admonitions**\r\n\r\n### Feature or Bugfix\r\n- Feature\r\n\r\n### Purpose\r\nSphinx is able to a defined set of admonitions (*attention, caution, danger, error, hint, important, note, tip, warning*), but napoleon only supports a subset of them as section titles. This PR intends to fill the gap.\r\n\r\n### Details\r\n\r\n- Map napoleon docstring section names to Sphinx admonitions:\r\n\r\n    Section | Admonition | Already implemented | Added by this PR\r\n    --- | --- | --- | ---\r\n    Attention | attention | | :heavy_check_mark:\r\n    Caution | caution | | :heavy_check_mark:\r\n    Danger | danger | |:heavy_check_mark:\r\n    Error | error | | :heavy_check_mark:\r\n    Hint | hint | | :heavy_check_mark:\r\n    Important | important | | :heavy_check_mark:\r\n    Note | note | :heavy_check_mark: |\r\n    See Also | seealso | :heavy_check_mark: |\r\n    Tip | tip | | :heavy_check_mark:\r\n    Todo | todo | :heavy_check_mark: |\r\n    Warning | warning | :heavy_check_mark: |\r\n    Warnings | warning | :heavy_check_mark: |\r\n\r\n- Add tests for GoogleDocstring\r\n\r\n  * Check multiple lines\r\n    ```\r\n    Section:      ---------->        .. admonition::\r\n        foo  \r\n        bar                             foo \r\n                                        bar\r\n    ```\r\n\r\n  * Check single line\r\n    ```\r\n    Section:      ---------->        .. admonition:: foo\r\n        foo \r\n    ```\r\n\r\n- Add tests for NumpyDocstring\r\n\r\n  * Check multiple lines\r\n    ```\r\n    Section      ---------->        .. admonition::\r\n    -------\r\n    foo                                foo\r\n    bar                                bar\r\n    ```\r\n\r\n\r\n  * Check single line\r\n    ```\r\n    Section      ---------->        .. admonition:: foo\r\n    -------\r\n    foo\r\n    ```\r\n\r\n### Relates \r\n#3901 \r\n"},"comment":{"url":"https://api.github.com/repos/sphinx-doc/sphinx/issues/comments/365333827","html_url":"https://github.com/sphinx-doc/sphinx/pull/4613#issuecomment-365333827","issue_url":"https://api.github.com/repos/sphinx-doc/sphinx/issues/4613","id":365333827,"user":{"login":"althonos","id":8660647,"avatar_url":"https://avatars3.githubusercontent.com/u/8660647?v=4","gravatar_id":"","url":"https://api.github.com/users/althonos","html_url":"https://github.com/althonos","followers_url":"https://api.github.com/users/althonos/followers","following_url":"https://api.github.com/users/althonos/following{/other_user}","gists_url":"https://api.github.com/users/althonos/gists{/gist_id}","starred_url":"https://api.github.com/users/althonos/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/althonos/subscriptions","organizations_url":"https://api.github.com/users/althonos/orgs","repos_url":"https://api.github.com/users/althonos/repos","events_url":"https://api.github.com/users/althonos/events{/privacy}","received_events_url":"https://api.github.com/users/althonos/received_events","type":"User","site_admin":false},"created_at":"2018-02-13T17:06:05Z","updated_at":"2018-02-13T17:06:05Z","author_association":"CONTRIBUTOR","body":"Great ! "}}
{"actor":{"display_login":"althonos"}}