{"action":"created","issue":{"url":"https://api.github.com/repos/sphinx-doc/sphinx/issues/3278","repository_url":"https://api.github.com/repos/sphinx-doc/sphinx","labels_url":"https://api.github.com/repos/sphinx-doc/sphinx/issues/3278/labels{/name}","comments_url":"https://api.github.com/repos/sphinx-doc/sphinx/issues/3278/comments","events_url":"https://api.github.com/repos/sphinx-doc/sphinx/issues/3278/events","html_url":"https://github.com/sphinx-doc/sphinx/pull/3278","id":197441551,"number":3278,"title":"Implement a py-classindex and py-funindex additionally to the default py-modindex","user":{"login":"Naereen","id":11994719,"avatar_url":"https://avatars.githubusercontent.com/u/11994719?v=3","gravatar_id":"","url":"https://api.github.com/users/Naereen","html_url":"https://github.com/Naereen","followers_url":"https://api.github.com/users/Naereen/followers","following_url":"https://api.github.com/users/Naereen/following{/other_user}","gists_url":"https://api.github.com/users/Naereen/gists{/gist_id}","starred_url":"https://api.github.com/users/Naereen/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Naereen/subscriptions","organizations_url":"https://api.github.com/users/Naereen/orgs","repos_url":"https://api.github.com/users/Naereen/repos","events_url":"https://api.github.com/users/Naereen/events{/privacy}","received_events_url":"https://api.github.com/users/Naereen/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":1,"created_at":"2016-12-24T01:09:11Z","updated_at":"2016-12-24T01:22:58Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/sphinx-doc/sphinx/pulls/3278","html_url":"https://github.com/sphinx-doc/sphinx/pull/3278","diff_url":"https://github.com/sphinx-doc/sphinx/pull/3278.diff","patch_url":"https://github.com/sphinx-doc/sphinx/pull/3278.patch"},"body":"Subject: Implement a `py-classindex` and `py-funindex` additionally to the default `py-modindex`.\r\n\r\n### Feature\r\n- Add two index pages for the Python domain: `classindex` and `funindex`\r\n- Suggestion to fix #3178. Not fully mature yet, but it works already\r\n\r\n### Purpose\r\n- Provides a cleaner and fully static solution to [this question](https://stackoverflow.com/questions/12150491/toc-list-with-all-classes-generated-by-automodule-in-sphinx-docs)\r\n\r\n### Detail\r\n- The code in `sphinx.domains.python.PythonClassIndex` and `sphinx.domains.python.PythonFunIndex` is very similar  to `sphinx.domains.python.PythonModuleIndex`\r\n- So the look of the resulting index pages are very similar, but they do the job I think (see below for screenshots in the comments)\r\n- I added the new feature in the `CHANGES` file\r\n- It adds two config value, `classindex_common_prefix` and `funindex_common_prefix` that are exactly like `modindex_common_prefix`, and are documented and initialized similarly\r\n- I updated manually the French ``.po`` file, but cannot do the same for other languages\r\n\r\n### Other things to do ?\r\n- Add a test ?\r\n- Add the label links to ``classindex`` and ``funindex`` after the label link to ``modindex`` in the default template (for Python domain only) ?\r\n- Do the same for ``data`` (constants) ?\r\n\r\n### Relates\r\n- #3178\r\n\r\n"},"comment":{"url":"https://api.github.com/repos/sphinx-doc/sphinx/issues/comments/269062375","html_url":"https://github.com/sphinx-doc/sphinx/pull/3278#issuecomment-269062375","issue_url":"https://api.github.com/repos/sphinx-doc/sphinx/issues/3278","id":269062375,"user":{"login":"Naereen","id":11994719,"avatar_url":"https://avatars.githubusercontent.com/u/11994719?v=3","gravatar_id":"","url":"https://api.github.com/users/Naereen","html_url":"https://github.com/Naereen","followers_url":"https://api.github.com/users/Naereen/followers","following_url":"https://api.github.com/users/Naereen/following{/other_user}","gists_url":"https://api.github.com/users/Naereen/gists{/gist_id}","starred_url":"https://api.github.com/users/Naereen/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Naereen/subscriptions","organizations_url":"https://api.github.com/users/Naereen/orgs","repos_url":"https://api.github.com/users/Naereen/repos","events_url":"https://api.github.com/users/Naereen/events{/privacy}","received_events_url":"https://api.github.com/users/Naereen/received_events","type":"User","site_admin":false},"created_at":"2016-12-24T01:22:57Z","updated_at":"2016-12-24T01:22:57Z","body":"Here are some screenshots:\r\n\r\n- The added `classindex` and `funindex` label link on a `.rst` page: (not translated yet)\r\n![demo main index](https://cloud.githubusercontent.com/assets/11994719/21464500/32957dc0-c97f-11e6-87bc-af2049f56bec.png)\r\n\r\n- Example of a class index with some classes, order by modules (exactly as the default mod index):\r\n![demo class index](https://cloud.githubusercontent.com/assets/11994719/21464507/627143a8-c97f-11e6-9fd3-41a5058f81de.png)\r\n\r\n- 2 examples of a fun index with some functions, order by modules (exactly as the default mod index):\r\n![demo fun index](https://cloud.githubusercontent.com/assets/11994719/21464512/7b564fb2-c97f-11e6-80e4-75add3b23e35.png)\r\n![demo fun index 2](https://cloud.githubusercontent.com/assets/11994719/21464523/db5c9f1a-c97f-11e6-833a-fe5735b8f711.png)"}}
{"actor":{"display_login":"Naereen"}}