{
    "info": {
        "author": "Suzumizaki-Kimitaka(\u9234\u898b\u54b2 \u541b\u9ad8)",
        "author_email": "info@h12u.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 5 - Production/Stable",
            "Environment :: Console",
            "Environment :: Web Environment",
            "Framework :: Sphinx",
            "Framework :: Sphinx :: Extension",
            "Intended Audience :: Developers",
            "Intended Audience :: Education",
            "License :: OSI Approved :: BSD License",
            "Operating System :: OS Independent",
            "Programming Language :: Python",
            "Programming Language :: Python :: 2",
            "Programming Language :: Python :: 3",
            "Topic :: Documentation",
            "Topic :: Documentation :: Sphinx",
            "Topic :: Text Processing",
            "Topic :: Utilities"
        ],
        "description": "gosyu extension\n===============\n\n.. note::\n\n   Japanese version of this document is also available, on the `site\n   <http://h12u.com/sphinx/gosyu/README_ja.html>`_ or the doc\n   folder of this package.\n\n.. role:: fn_rst\n\nIntroduction\n------------\nCurrently, June 7, 2015, Sphinx 1.3.1 sorts indices *only* with\n'Normalization Form Canonical Decomposition(NFD)'. And what is worse,\ngrouping is done *only* with US-ASCII. There is non or few problems \nwhen you use the language similar to English, because the NFD method\ndecompose diacritical marks.\n\nBut with the other languages, the grouping is useless. Almost all\ncharacters are grouped into 'Symbols'. What a meaningless behavior\nit is!\n\nI don't know what happens with each language in the world, but one \nof the worst might be Japanese case. The many terms are written with\nkanzi (kanji, \u6f22\u5b57, Chinese characters), and the sorting should be\ndone by how to read, that generally cannot be defined from the\ncharacters of the terms.\n\nThis extension tries to resolve these problems above, using sortorder_.\nNot only with these problematic languages, you can define the alternate\nsort order for any language you want.\n\nSorry to say, this extension can resolve :code:`.. glossary::` directive\nonly, by replacing with :code:`.. gosyu::` one. Other directives like\n:code:`index` would be resolved with future release. \n\nLicense\n-------\n2-clause BSD, same as the Sphinx project.\n\nInstallation\n------------\nYou can install or uninstall this package like another Python packages.\nAlso, you can use this package without installing this package on your Python\nsystems, the configuration file of Sphinx(:fn_rst:`conf.py`) enable you to use.\n\nSystem requirements\n...................\nTested with 32bit version of Python 2.7.10 and 64bit version of 3.4.3,\nboth on the Microsoft Windows 8.1 Pro 64bit edition. But with another\nversions and on another OSs would be usable.\n\nPython 3 is required if you need full unicode support.\nWhen used with Python 2, the usable character set is limited\nwith local encoding.\n\n.. note::\n\n   There's another extension yogosyu_ that fixes generation\n   of the :fn_rst:`genindex.html` instead of adding\n   :fn_rst:`std-gosyu.html`.\n\n   But yogosyu_ can be unstable against Sphinx or docutils\n   update than this module.\n\nHow to install\n..............\nYou can install this package as you will do with another one.\n\n#. Open a console and do :code:`pip install gosyu`.\n\n   On the MS-Windows,\n   :code:`<python_installed_path>\\Scripts\\pip.exe install gosyu`.\n\n#. Or when you get zip archive like :fn_rst:`gosyu-2.0.6(.zip)`\n   where '2.0.6' is version number,\n   change current directiory to the folder that has the zip file,\n   and do :code:`pip install gosyu-2.0.6.zip`.\n\n   On the MS-Windows,\n   :code:`<python_installed_path>\\Scripts\\pip.exe install gosyu-2.0.6.zip`.\n\n#. Or, this way is the Sphinx specific, you can use this package just extracted\n   any folder you want. the :fn_rst:`conf.py` enables you to use the themes and\n   extensions.\n\nIf you don't resolve dependencies, you also have to get sortorder_ module.\n\nHow to use\n----------\n\n1) Add the paths\n................\nAs another extensions, you can use this extension by editing :fn_rst:`conf.py`.\n\nFirst, you should add:\n\n.. code-block:: python\n\n  # add 4 lines below\n  import distutils.sysconfig\n  site_package_path = distutils.sysconfig.get_python_lib()\n  sys.path.insert(0, os.path.join(site_package_path, 'sortorder'))\n  sys.path.insert(0, os.path.join(site_package_path, 'sphinxcontrib/gosyu'))\n\nOr, when you don't install with pip or like,\n\n.. code-block:: python\n\n  # add just 2 line below\n  sys.path.insert(0, '<path_to_the_folder_contains_sortorder___init___py>')\n  sys.path.insert(0, '<path_to_the_folder_contains_gosyu_py>')\n\nIf you want to use your own sort order module(.py file), you should add\nthe path of it, too:\n\n.. code-block:: python\n\n  # after adding paths as above, add the line below.\n  sys.path.insert(0, '<path_to_the_folder_sort_order_xx_py>')\n\n.. note::\n\n  The module sortorder_ has each preset order for some languages.\n\n  Please read the document of the module to know how to use them or how\n  to make your own order.\n\n2) declare the extensions\n.........................\nNext, add gosyu extension into :code:`extension` list:\n\n.. code-block:: python\n\n   language = 'xx' # make sure your language if you want to use autodetect\n\n   #\n   # (snip...)\n   #\n\n   extension = [\n     'sort_order_xx', # omit when using one of preset sort order or autodetect\n     'sortorder', # you can omit always, because 'gosyu' automatically loads\n     'gosyu', # required.\n   ] # Of course you can add another extensions.\n\n3) replace 'glossary' with 'gosyu'\n....................................\nNow, just replace :code:`.. glossary::` with :code:`.. gosyu::`.\nWhen :code:`:sorted:` is given, the terms are sorted in each glossary.\n\nAnd anyway, the general index in :fn_rst:`genindex.html` is also sorted\nas you want to define.\n\n4) add the how to read each terms\n.................................\nFor the languages like Japanese, :code:`.. gosyu::` directive has another \noption :code:`:yomimark: <a separater char>`. the separator is a character\nyou want to use split. When the separator is given, the term can be followed\nthe string how to read. If you think some terms don't need the reading, you\ncan simply omit for the terms.\n\nConsider to use the preset Japanese sort order defined in sortorder_\nextension:\n\n.. code-block:: python\n\n   language = 'ja'\n\n   #\n   # (snip...)\n   #\n\n   extension = [\n     'gosyu',\n   ]  # all omitted modules will be automatically loaded\n\nAnd write glossary like:\n\n.. code-block:: rst\n\n  .. gosyu::\n    :sorted:\n    :yomimark: \u3001\n\n    \u3072\u3089\u304c\u306a\n\n      \u6bd4\u8f03\u7684\u66f2\u7dda\u304c\u591a\u3044\u65e5\u672c\u8a9e\u306e\u8868\u97f3\u6587\u5b57\n\n    \u30ab\u30bf\u30ab\u30ca\n\n      \u6bd4\u8f03\u7684\u76f4\u7dda\u304c\u591a\u3044\u65e5\u672c\u8a9e\u306e\u8868\u97f3\u6587\u5b57\n\n    \u6f22\u5b57\u3001\u304b\u3093\u3058\n\n      \u65e5\u672c\u8a9e\u3067\u3082\u4f7f\u308f\u308c\u308b\u8868\u610f\u6587\u5b57\n\n    \u82f1\u5b57\u3001\u3048\u3044\u3058\n\n      \u7fa9\u52d9\u6559\u80b2\u3067\u6559\u308f\u308b\u305f\u3081\u3001\u65e5\u672c\u8a9e\u3067\u3082\u3088\u304f\u4f7f\u308f\u308c\u308b\u8868\u97f3\u6587\u5b57\n\n    \u8a18\u53f7\u3001\u304d\u3054\u3046\n\n      \u56fd\u5185\u56fd\u5916\u3092\u554f\u308f\u305a\u591a\u7a2e\u591a\u69d8\u306a\u8a18\u53f7\u304c\u643a\u5e2f\u96fb\u8a71\u306a\u3069\u3067\u3082\u4f7f\u3048\u308b\u3088\u3046\u306b\u306a\u3063\u3066\u304d\u305f\n\nThe separator is :code:`\u3001` (U+3001) in this case.\n\nThis reorders the terms :code:`\u82f1\u5b57 -> \u30ab\u30bf\u30ab\u30ca -> \u6f22\u5b57 -> \u8a18\u53f7 -> \u3072\u3089\u304c\u306a`.\nThe preset :fn_rst:`sortorder.ja` module sorts them depending on\n:code:`\u3048\u3044\u3058, \u30ab\u30bf\u30ab\u30ca, \u304b\u3093\u3058, \u304d\u3054\u3046, \u3072\u3089\u304c\u306a`.\n\nAnd in the :fn_rst:`genindex.html`, :code:`\u30ab\u30bf\u30ab\u30ca, \u6f22\u5b57, \u8a18\u53f7` is grouped in\none heading :code:`\u304b`. Also because the module desides it depending on how to\nread.\n\n.. note::\n\n   If you want to use space(U+0020) or tab(U+0009) for the separator, you can\n   write :code:`:yomimark: space` or :code:`:yomimark: tab`.\n\n5) options written in conf.py\n.............................\nThere is 3 options to change some strings.\n\n- :code:`gosyu_shortname = u'\u7528\u8a9e\u96c6'` \n\n  - a short name for the index, for use in the relation bar in\n\n- :code:`gosyu_localname = u'\u7528\u8a9e\u96c6'`\n\n  - the section title for the index\n\n- :code:`gosyu_anchor_prefix = 'yogo_'`\n\n  - the prefix of the anchors to link from/to HTML files.\n\nTODO\n----\n\nI don't know how to make the reference to :fn_rst:`std-gosyu.html` like\n\\:ref\\:\\`genindex\\` .\n\nAs workaround, use:\n\n.. code:: ReST\n\n   `gosyu index <./std-gosyu.html>`_\n\nor:\n\n.. code:: ReST\n\n   gosyu_index_\n\n   ...\n\n   .. _gosyu_index: ./std-gosyu.html\n\nRelated products\n----------------\n- unicode_ids_\n\n  - enable the Sphinx to generate URL with Non-ASCII characters.\n\n- sortorder_\n\n  - the base module of this product.\n\n- yogosyu_\n\n  - anothor implementation for the same purpose of this package.\n    more unstable against Sphinx updates, but directly fixes\n    :fn_rst:`genindex.html` instead of generating\n    :fn_rst:`std-gosyu.html`.\n\nAuthor\n------\nSuzumizaki-Kimitaka(\u9234\u898b\u54b2 \u541b\u9ad8), 2011-2015\n\nHistory\n-------\n2.0.6(2015-07-04):\n\n  Fix documentation(this file) for PyPI.\n\n2.0.5(2015-07-04):\n\n  - part the modules sortorder_ and unicode_ids_ from this package.\n  - registered on PyPI.\n\n2013-12-07:\n\n  Add Python 3 support.\n\n2013-12-06:\n\n  updated to meet Sphinx 1.2.\n\n2011-05-24:\n\n  First release. Includes sortorder_ and unicode_ids_.\n\n.. _sortorder: https://pypi.python.org/pypi/sortorder\n.. _unicode_ids: https://pypi.python.org/pypi/unicode_ids\n.. _yogosyu: https://pypi.python.org/pypi/yogosyu",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "UNKNOWN",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "http://h12u.com/sphinx/gosyu/",
        "keywords": null,
        "license": "BSD",
        "maintainer": null,
        "maintainer_email": null,
        "name": "gosyu",
        "package_url": "https://pypi.org/project/gosyu/",
        "platform": "any",
        "project_url": "https://pypi.org/project/gosyu/",
        "project_urls": {
            "Download": "UNKNOWN",
            "Homepage": "http://h12u.com/sphinx/gosyu/"
        },
        "release_url": "https://pypi.org/project/gosyu/2.0.6/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "Fix the Sphinx to enable any order to sort indices(using domain feature)",
        "version": "2.0.6"
    },
    "last_serial": 1618943,
    "releases": {
        "2.0.5": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "92c2c6f38b46d751bf271bab3292560a",
                    "sha256": "0ecc7040635746d6f9850257c817fd048a59a7ade2160f15639b5eff92e27b5a"
                },
                "downloads": -1,
                "filename": "gosyu-2.0.5-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "92c2c6f38b46d751bf271bab3292560a",
                "packagetype": "bdist_wheel",
                "python_version": "2.7",
                "requires_python": null,
                "size": 255233,
                "upload_time": "2015-07-04T03:55:10",
                "url": "https://files.pythonhosted.org/packages/18/2a/44e9a291d7c0e499d3d708f2dffcc8ae7e2f4ca1f96ba2d6777f257471ce/gosyu-2.0.5-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "92d6c4fc674b17b7e19082923a7ac67e",
                    "sha256": "14bbd12168c7f616e8ca6cb5d32711a1eec33d9b9b026077c6a73e0ae5223ec2"
                },
                "downloads": -1,
                "filename": "gosyu-2.0.5.zip",
                "has_sig": false,
                "md5_digest": "92d6c4fc674b17b7e19082923a7ac67e",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 296975,
                "upload_time": "2015-07-04T03:55:04",
                "url": "https://files.pythonhosted.org/packages/ac/c1/169242be067eb041e3f6ee24e32ea74ca1b5d0590cfa5260bb98e23b0372/gosyu-2.0.5.zip"
            }
        ],
        "2.0.6": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "afe01290be47edfe4272fd1e864d3283",
                    "sha256": "306b3e41fd9e2ff765488e08eb68e6bb258fe59b7c25498cfe941a7ff4c66b12"
                },
                "downloads": -1,
                "filename": "gosyu-2.0.6-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "afe01290be47edfe4272fd1e864d3283",
                "packagetype": "bdist_wheel",
                "python_version": "2.7",
                "requires_python": null,
                "size": 255406,
                "upload_time": "2015-07-04T04:01:52",
                "url": "https://files.pythonhosted.org/packages/ed/5b/3ba1c68313de51d425ecde239d1a782032d591758a231e860efcfd3eced7/gosyu-2.0.6-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "9020785dfa7fdf6a4173be153ead9bc8",
                    "sha256": "b6055b192c91f9a68e3b398f5e2a80a749309ba7906ed7203149551a3ad82399"
                },
                "downloads": -1,
                "filename": "gosyu-2.0.6.zip",
                "has_sig": false,
                "md5_digest": "9020785dfa7fdf6a4173be153ead9bc8",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 297371,
                "upload_time": "2015-07-04T04:01:47",
                "url": "https://files.pythonhosted.org/packages/e9/c4/c0d5e3e5e0a1701ce53f619a198410c527bff99a08b91dc1ce56fad0d11a/gosyu-2.0.6.zip"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "afe01290be47edfe4272fd1e864d3283",
                "sha256": "306b3e41fd9e2ff765488e08eb68e6bb258fe59b7c25498cfe941a7ff4c66b12"
            },
            "downloads": -1,
            "filename": "gosyu-2.0.6-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "afe01290be47edfe4272fd1e864d3283",
            "packagetype": "bdist_wheel",
            "python_version": "2.7",
            "requires_python": null,
            "size": 255406,
            "upload_time": "2015-07-04T04:01:52",
            "url": "https://files.pythonhosted.org/packages/ed/5b/3ba1c68313de51d425ecde239d1a782032d591758a231e860efcfd3eced7/gosyu-2.0.6-py2.py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "9020785dfa7fdf6a4173be153ead9bc8",
                "sha256": "b6055b192c91f9a68e3b398f5e2a80a749309ba7906ed7203149551a3ad82399"
            },
            "downloads": -1,
            "filename": "gosyu-2.0.6.zip",
            "has_sig": false,
            "md5_digest": "9020785dfa7fdf6a4173be153ead9bc8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 297371,
            "upload_time": "2015-07-04T04:01:47",
            "url": "https://files.pythonhosted.org/packages/e9/c4/c0d5e3e5e0a1701ce53f619a198410c527bff99a08b91dc1ce56fad0d11a/gosyu-2.0.6.zip"
        }
    ]
}