{ "info": { "author": "Suzumizaki-Kimitaka(\u9234\u898b\u54b2 \u541b\u9ad8)", "author_email": "info@h12u.com", "bugtrack_url": null, "classifiers": [ "Framework :: Sphinx :: Extension", "Framework :: Sphinx :: Theme", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Topic :: Documentation :: Sphinx", "Topic :: Software Development :: Documentation" ], "description": "Sphinx HTML5 basic theme\n========================\n\n.. caution::\n\n 'html5_sphinxdoc' will not work until the `bug `_ is resolved.\n 'html5_basic' theme and 'sphinx_html5_translator' extension go fine.\n\n If you want to use 'html5_sphinxdoc', add the path to 'html_theme'. see 'doc/conf.py'.\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, May 6, 2015, Sphinx 1.3.1 cannot generate valid HTML5 files\\ [#f1]_\\ .\n\nThis package includes HTML5 and CSS3 versions of the two standard themes,\n*basic* and *sphinxdoc*.\nAnd one extension, named :fn_rst:`sphinx_html5_translator(.py)`.\n\nBy using them, you can generate HTML files that will pass the validator. Enjoy!\n\nLicense\n-------\nBSD, same as the Sphinx project itself.\n(All files are intend to enable merge or enable overwrite the Sphinx project for the future.)\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............\n- Sphinx 1.3 compatible\n\n - docutils 0.12 compatible\n - note that their changes may or may not break the functionality of the code in this packages, as the one in another packages may.\n\n- tested with: 32bit version of Python 2.7.9 and 64bit version of 3.4.3, both on the Microsoft Windows 8.1 Pro 64bit edition\n - but 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 sphinx_html5_basic_theme`.\n\n On the MS-Windows,\n :code:`\\Scripts\\pip.exe install sphinx_html5_basic_theme`.\n\n#. Or when you get zip archive like :fn_rst:`sphinx_html5_basic_theme-1.0.5(.zip)`\n where '1.0.5' is version number,\n change current directiory to the folder that has the zip file,\n and do :code:`pip install sphinx_html5_basic_theme-1.0.5.zip`.\n\n On the MS-Windows,\n :code:`\\Scripts\\pip.exe install sphinx_html5_basic_theme-1.0.5.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\n----------\n\nDo you already know how to `switch HTML theme `_\nand to `use extension `_ ?\nif not, learn them first.\n\n1) set the html5 theme\n......................\nAt first, you should choice the theme :code:`html5_basic` or\n:code:`html5_sphinxdoc`. The latter refers the former, but you\ndon't have to care about that as the structure of the folders resolves.\n\nOn the :fn_rst:`conf.py` in your project(s), fix :code:`html_theme` like\n:code:`html_theme = 'html5_sphinxdoc'` as you choise.\n\nIf you want to use this package just extracted zip and not\ninstalled on your python system, you should do more, add\n:code:`html_theme_path = ['',]`.\n\n.. note::\n\n As described the top of this document, you should declare\n :code:`html_theme_path` anyway, above until the bug is fixed.\n\n2) set the html5 translator extension\n.....................................\nSecond, you should use the extension :fn_rst:`sphinx_html5_translator(.py)`.\nBecause some invalid tags and attributes are emitted by docutils.\n\nto use :fn_rst:`sphinx_html5_translator`, you should add the path to the \nextension to :code:`sys.path` like below, at the early part of your\n:fn_rst:`conf.py`. This part is different whether this package is installed\non the Python system or not.\n\nAfter that, set the extension as :code:`extension = ['sphinx_html5_translator', ]`.\nOf course you can add another extensions you want to use.\n\nAdd the path for installed this package:\n\n.. code-block:: python\n\n # add 3 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, 'sphinx_html5_basic_theme'))\n\nand for not installed this package:\n\n.. code-block:: python\n\n # add just 1 line below\n sys.path.insert(0, '')\n\nNote that :code:`` and :code:``\nis same as the case of this package.\n\n.. note::\n\n If you don't mind or want to do, you can copy the file\n :fn_rst:`sphinx_html5_translator.py` to the folder you want, \n add :code:`sys.path.insert(0, '')`,\n and set the valuable :code:`extension` like above.\n\nChanges against html4 version\n-----------------------------\n- Uses CSS3, but some modules are not W3C Reccomendation yet.\n\n - `Flexible Box Layout Module Level 1 `_ is last call working draft\n - `Multi-column Layout Module `_ is cadidate reccomendation\n\n- Flexible Box Layouts used\n\n - relational navigations\n - sidebar box and main contents box\n - input box and go button in quick search\n\n- Multi-column Layout used\n\n - :fn_rst:`genindex.html`. you can change column count with style sheet.\n\n- sidebarwidth is now accepts unit postfix, like :code:`\"50em\"`\n- the sidebar is displayed even sphinx_html5_basic\n- width defition of the quick search button is deleted. that is too narrow to show the translations of 'Go !'\n- :code:`table.indextable` is replaced with Flexible Box Layout. The new style :code:`genindex-multi-columens` is added.\n- Some brakets and markers are removed, intend to use style sheets.\n\n - relational navigations (:code:`\u00bb` and :code:`|`)\n - separators between head characters in index pages(:code:`|`)\n - brakets with footnote and common named index(:code:`[` and :code:`]`)\n\n- :code:`{% block searchtip %}` is defined, to replace the description of the quick search\n- :code:`{% block extra_footer %}` is defined, to append something at last of the footer\n- :code:`{% expired_html_link %}` is defined and emit nothing. :code:`top` and :code:`up` is obsoleted.\n- images used with sphinxdoc theme is deleted. altered with style sheet.\n- the separator lines designed with sphinxdoc now always touch the top of the footer, even when the main content is too short.\n\nAuthor\n------\nSuzumizaki-Kimitaka, 2015-04-30\n\nRelated products\n----------------\n- unicode_ids_\n\n - enable the Sphinx to generate URL with Non-ASCII characters.\n\nHistory\n-------\n1.0.5(2015-06-19):\n\n - add wheel build for install.\n - work around added in doc/conf.py until resolve the bug of Sphinx.\n - work around against setup.py due to the bug of pip running on Python 3.\n see https://github.com/pypa/pip/pull/2916\n\n1.0.4(2015-05-25):\n\n fix document about the project extension folder.\n\n1.0.3(2015-05-10):\n\n fix how to use chapter.\n\n1.0.2(2015-05-10):\n\n Re-upload\n\n1.0.1(2015-05-10):\n\n Add README.rst to doc folder that lost from the previous version.\n\n1.0.0(2015-05-09):\n\n First release. All files are copied at first from Sphinx 1.3.1 and\n docutils 0.12 with Python 2.7.9 and 3.4.3 on Microsoft Windows 8.1 Pro 64bit.\n\n the themes html5_basic and html5_sphinxdoc are released.\n the extension sphinx_html5_translator is released.\n\n.. rubric:: Footnote\n\n.. [#f1] `W3C Markup Validation Service `_\n\n.. _unicode_ids: https://pypi.python.org/pypi/unicode_ids", "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": "sphinx_html5_basic_theme", "package_url": "https://pypi.org/project/sphinx_html5_basic_theme/", "platform": "any", "project_url": "https://pypi.org/project/sphinx_html5_basic_theme/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://h12u.com/sphinx/html5_basic_theme/" }, "release_url": "https://pypi.org/project/sphinx_html5_basic_theme/1.0.5/", "requires_dist": null, "requires_python": null, "summary": "Enable Sphinx to generate HTML5 valid files", "version": "1.0.5" }, "last_serial": 1598460, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "3a66c11e7cdea7b9164529a1262a933e", "sha256": "9e2a70ca64e0ca859e0051efe353f55f217783c1db7cea4535a53b6405aa04db" }, "downloads": -1, "filename": "sphinx_html5_basic_theme-1.0.0.zip", "has_sig": false, "md5_digest": "3a66c11e7cdea7b9164529a1262a933e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 209139, "upload_time": "2015-05-09T08:46:44", "url": "https://files.pythonhosted.org/packages/6b/b7/5a04e336171c5ecd1557a7373e952463a6a2c39943455d8bc6d35be6f744/sphinx_html5_basic_theme-1.0.0.zip" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "859c46b4bcc8c2c9b69c012a3d1e82e8", "sha256": "466bb5359d4139713258ba983342ffa7bbad31235d2826101fa0bb61d0ab4de5" }, "downloads": -1, "filename": "sphinx_html5_basic_theme-1.0.1.zip", "has_sig": false, "md5_digest": "859c46b4bcc8c2c9b69c012a3d1e82e8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 212710, "upload_time": "2015-05-09T23:37:53", "url": "https://files.pythonhosted.org/packages/75/9f/6db972244ae3179dfa10620f6697beb48830c7363bc47b0edce0de812254/sphinx_html5_basic_theme-1.0.1.zip" } ], "1.0.2": [ { "comment_text": "", "digests": { "md5": "b16d1a8787972a001b4b9f43830519d6", "sha256": "f558a6ba6f94403630f6db921a404503c4317828a33b8086e20721d473eea56d" }, "downloads": -1, "filename": "sphinx_html5_basic_theme-1.0.2.zip", "has_sig": false, "md5_digest": "b16d1a8787972a001b4b9f43830519d6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 212795, "upload_time": "2015-05-09T23:48:52", "url": "https://files.pythonhosted.org/packages/14/f8/fc45a939675226b6a2f90aa58d6f2e8c44c07a03394bfc486f7244041419/sphinx_html5_basic_theme-1.0.2.zip" } ], "1.0.3": [ { "comment_text": "", "digests": { "md5": "9838f61a2d225c122612c39a1dbc2940", "sha256": "7305062d844b423cf70d920cf05e05c57ffb75db3df8be700fd5e7ae14c296db" }, "downloads": -1, "filename": "sphinx_html5_basic_theme-1.0.3.zip", "has_sig": false, "md5_digest": "9838f61a2d225c122612c39a1dbc2940", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 214296, "upload_time": "2015-05-10T06:15:37", "url": "https://files.pythonhosted.org/packages/7d/42/4015cc3970b53785148109eb008b66e2d29d1bfc4c5ff11d25e5f46e7dc7/sphinx_html5_basic_theme-1.0.3.zip" } ], "1.0.4": [ { "comment_text": "", "digests": { "md5": "a2d4250366906bb825e897a8912d3487", "sha256": "60761c2dca7e09cc1fafed1a3a1835e7a6449fa7af4698c59ba510e790409aab" }, "downloads": -1, "filename": "sphinx_html5_basic_theme-1.0.4.zip", "has_sig": false, "md5_digest": "a2d4250366906bb825e897a8912d3487", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 214992, "upload_time": "2015-05-25T12:26:29", "url": "https://files.pythonhosted.org/packages/71/e3/df9c1ab7da201b241f8599aca197ea9f6005e7a56ed970f6fa523abf9bca/sphinx_html5_basic_theme-1.0.4.zip" } ], "1.0.5": [ { "comment_text": "", "digests": { "md5": "947ea121180ed7a585cfe03ce45a0280", "sha256": "ede13a56a7976d9210b71deb70c7915caf3b0d159419be9f8d15da636553fbfe" }, "downloads": -1, "filename": "sphinx_html5_basic_theme-1.0.5-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "947ea121180ed7a585cfe03ce45a0280", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 210498, "upload_time": "2015-06-19T02:12:32", "url": "https://files.pythonhosted.org/packages/1d/da/3e7ba18c6373ab8bc9124c3997a30c4e41c10d9b348560fb34b172fc18cd/sphinx_html5_basic_theme-1.0.5-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e86727a9af8f269d058e85c3707a7973", "sha256": "713d77f464704daf7111f92f52210b48f842e3e8c218bdce7ec22e7cd1cefb87" }, "downloads": -1, "filename": "sphinx_html5_basic_theme-1.0.5.zip", "has_sig": false, "md5_digest": "e86727a9af8f269d058e85c3707a7973", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 216035, "upload_time": "2015-06-19T02:12:26", "url": "https://files.pythonhosted.org/packages/5f/4d/2c73573b360714ffb32da245e13513bc6d9c2d68d6ae5d13eeb61df7761b/sphinx_html5_basic_theme-1.0.5.zip" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "947ea121180ed7a585cfe03ce45a0280", "sha256": "ede13a56a7976d9210b71deb70c7915caf3b0d159419be9f8d15da636553fbfe" }, "downloads": -1, "filename": "sphinx_html5_basic_theme-1.0.5-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "947ea121180ed7a585cfe03ce45a0280", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 210498, "upload_time": "2015-06-19T02:12:32", "url": "https://files.pythonhosted.org/packages/1d/da/3e7ba18c6373ab8bc9124c3997a30c4e41c10d9b348560fb34b172fc18cd/sphinx_html5_basic_theme-1.0.5-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e86727a9af8f269d058e85c3707a7973", "sha256": "713d77f464704daf7111f92f52210b48f842e3e8c218bdce7ec22e7cd1cefb87" }, "downloads": -1, "filename": "sphinx_html5_basic_theme-1.0.5.zip", "has_sig": false, "md5_digest": "e86727a9af8f269d058e85c3707a7973", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 216035, "upload_time": "2015-06-19T02:12:26", "url": "https://files.pythonhosted.org/packages/5f/4d/2c73573b360714ffb32da245e13513bc6d9c2d68d6ae5d13eeb61df7761b/sphinx_html5_basic_theme-1.0.5.zip" } ] }