{ "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": "sortorder extension\n====================\n\n.. note::\n\n Japanese version of this document is also available, on the `site `_ or the doc folder of this package.\n\n.. role:: fn_rst\n\nIntroduction\n------------\nCurrently, June 1, 2015, Sphinx 1.3.1 cannot generate localized heading in\nindex pages and glossary directives. This package make the *gate* to make\nthe Sphinx internationalized. This means another package is required to\ndo, I will make the one named 'Gosyu', please find that on pip.\n\nThis package does not depends on the Sphinx. You can use this for another\ntext proccesing product.\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\nRequirements\n............\nTested with 32bit version of Python 2.7.9 and 64bit version of 3.4.3,\nboth on the Microsoft Windows 8.1 Pro 64bit edition.\nBut with another versions and on another OSs would be usable.\n\nHow to install\n..............\nAgain, you can install this package as you will do with another one.\n\n#. Open a console and do :code:`pip install sortorder`.\n\n On the MS-Windows,\n :code:`\\Scripts\\pip.exe install sortorder`.\n\n#. Or when you get zip archive like :fn_rst:`sortorder-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:`setup.py sortorder-2.0.6.zip`.\n\n On the MS-Windows,\n :code:`\\Scripts\\pip.exe install sortorder-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\nHow to use (with Sphinx)\n------------------------\nTo know how to use the sort order you already have, see yogosyu_ or gosyu_.\n\nIf you want to use one of the preset sort orders this package has, just\n:code:`language = 'xx'`. it causes automatically load :fn_rst:`sortorder.xx`.\n\nCurrently, :code:`xx` is available :code:`ja`, :code:`eo`, :code:`el` and\n:code:`ru` for the presets.\n\nTo know how to make your own sortorder, see :fn_rst:`sortorder/__init__.py`.\n\nIn short:\n\n- determine the filename of the new module and create it.\n if you name :fn_rst:`sort_order_xx.py`, it will automatically loaded\n when :code:`language = 'xx'` is declared.\n- write :code:`import sortorder`.\n- make the class inherits :code:`sortorder.SortOrderBase`.\n- override :code:`get_string_to_sort` and :code:`get_group_name`.\n- make :code:`get_default_sort_order`\\ returns the instance of the class.\n- make :code:`setup`. see any of :fn_rst:`sortorder.xx` included this package.\n\nHow to use (General)\n--------------------\nIf you have this module not installed by pip, you should first do\n:code:`sys.path.insert(0, '')`.\n\nSecond, if you want directly use :code:`ja.py` (Japanese), :code:`eo.py` (Esperanto), \n:code:`el.py` (Greek) or :code:`ru.py` (Russian), Just do :code:`import sortorder.xxx`\nwhere :code:`xxx` is language code like :code:`ja`, :code:`eo`, etc.\n\nOtherwise, you should make the your sort-order module as you want.\nYou should define the new class which inherits\n:code:`sortorder.SortOrderBase`. The filename of the module should\nprefixed :code:`sort_order_`, like :fn_rst:`sort_order_xx.py`.\n\n:code:`get_default_sort_order` and :code:`setup` methods are only used by\nthe Sphinx document generator.\n\nAfter you make :fn_rst:`sort_order_xx.py` or you have it someone gives, add the path\nof the \\.py file to :code:`sys.path` like above. Next import the module:\n\n.. code-block:: python\n\n sys.path.insert(0, '')\n # (snip...)\n import sort_order_xx # may automatically import sortorder.__init__.py\n\nBut :fn_rst:`sortorder.__init__` has the method :code:`get_sort_order`.\nYou can add your code some automatic feature like used with the Sphinx,\nby defining :code:`get_default_sort_order` method in your module.\n\nAuthor\n------\nSuzumizaki-Kimitaka(\u9234\u898b\u54b2\u541b\u9ad8), 2011-2015\n\nHistory\n-------\n2.0.6(2015-07-04):\n\n Fix document(this file) for PyPI.\n\n2.0.5(2015-07-04):\n\n - Part from yogosyu_ extension.\n - First uploded to 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-06-28:\n\n Russian and Greek versions added.\n\n2011-05-24:\n\n First release. Included in yogosyu_ extension.\n Japanese and Esperanto versions included.\n\n.. _yogosyu: https://pypi.python.org/pypi/yogosyu\n.. _gosyu: https://pypi.python.org/pypi/gosyu", "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/html5_basic_theme/", "keywords": null, "license": "BSD", "maintainer": null, "maintainer_email": null, "name": "sortorder", "package_url": "https://pypi.org/project/sortorder/", "platform": "any", "project_url": "https://pypi.org/project/sortorder/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://h12u.com/sphinx/html5_basic_theme/" }, "release_url": "https://pypi.org/project/sortorder/2.0.6/", "requires_dist": null, "requires_python": null, "summary": "Enable Sphinx to generate HTML5 valid files", "version": "2.0.6" }, "last_serial": 1618922, "releases": { "2.0.5": [ { "comment_text": "", "digests": { "md5": "96a739df290d72d4121624036fdecd01", "sha256": "f6c05f6799070cf8306479fffe60697fcf9db6fdbe0d88378ef0e510b71d0f98" }, "downloads": -1, "filename": "sortorder-2.0.5-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "96a739df290d72d4121624036fdecd01", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 29211, "upload_time": "2015-07-04T03:48:13", "url": "https://files.pythonhosted.org/packages/45/0a/f8ca58aad34bf47d5680dbc4bf44c17f9cf008e26407cb19e5ec9a611f61/sortorder-2.0.5-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c69e0bac449009608f5834a5ad0980d7", "sha256": "ac2a14caf25ba2e537f55471e9277a3512489d12cc9cd01676cc591e79fb08e8" }, "downloads": -1, "filename": "sortorder-2.0.5.zip", "has_sig": false, "md5_digest": "c69e0bac449009608f5834a5ad0980d7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 32254, "upload_time": "2015-07-04T03:48:09", "url": "https://files.pythonhosted.org/packages/a0/a0/93f53214df3010671801143110837809e8e1553678c3d73bb6f4429dc279/sortorder-2.0.5.zip" } ], "2.0.6": [ { "comment_text": "", "digests": { "md5": "86a6d3e6d4d60456a7c44679be04f0d1", "sha256": "1ffd33b3cddc4b470881eab99e5fa1ab7f0c06c781dc0759dd38b04a58d68721" }, "downloads": -1, "filename": "sortorder-2.0.6-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "86a6d3e6d4d60456a7c44679be04f0d1", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 29290, "upload_time": "2015-07-04T03:54:30", "url": "https://files.pythonhosted.org/packages/0f/57/33eb9846603ea495663f19c2c18bfbecc79b5bccf744af1b447419048fdb/sortorder-2.0.6-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "65ec525cd9fe687c3e602aa9bb4d01b7", "sha256": "de1f113dea4e66d00812276c41ea52f7a502db1906b61a31d48d8ae5aab5593b" }, "downloads": -1, "filename": "sortorder-2.0.6.zip", "has_sig": false, "md5_digest": "65ec525cd9fe687c3e602aa9bb4d01b7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 32344, "upload_time": "2015-07-04T03:54:25", "url": "https://files.pythonhosted.org/packages/f2/e3/3a2b5e174a867745825a41644466c77d976eb316efb1924cdbdd3d249617/sortorder-2.0.6.zip" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "86a6d3e6d4d60456a7c44679be04f0d1", "sha256": "1ffd33b3cddc4b470881eab99e5fa1ab7f0c06c781dc0759dd38b04a58d68721" }, "downloads": -1, "filename": "sortorder-2.0.6-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "86a6d3e6d4d60456a7c44679be04f0d1", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 29290, "upload_time": "2015-07-04T03:54:30", "url": "https://files.pythonhosted.org/packages/0f/57/33eb9846603ea495663f19c2c18bfbecc79b5bccf744af1b447419048fdb/sortorder-2.0.6-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "65ec525cd9fe687c3e602aa9bb4d01b7", "sha256": "de1f113dea4e66d00812276c41ea52f7a502db1906b61a31d48d8ae5aab5593b" }, "downloads": -1, "filename": "sortorder-2.0.6.zip", "has_sig": false, "md5_digest": "65ec525cd9fe687c3e602aa9bb4d01b7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 32344, "upload_time": "2015-07-04T03:54:25", "url": "https://files.pythonhosted.org/packages/f2/e3/3a2b5e174a867745825a41644466c77d976eb316efb1924cdbdd3d249617/sortorder-2.0.6.zip" } ] }