{ "info": { "author": "Takeshi KOMIYA", "author_email": "i.tkomiya@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "Framework :: Sphinx :: Extension", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.6", "Topic :: Documentation", "Topic :: Documentation :: Sphinx" ], "description": "sphinxcontrib-getstart-sphinx\n=============================\n\n``sphinxcontrib-getstart-sphinx`` is a collection of Sphinx extensions to\nbuild `Sphinx\u3092\u306f\u3058\u3081\u3088\u3046 \u7b2c2\u7248 (Getting Started with Sphinx 2nd Edition)`__.\n\n__ https://www.oreilly.co.jp/books/9784873118192/\n\n\nThis package provides following extensions:\n\n``sphinxcontrib.getstart_sphinx.better_docref``\n Append section numbers to each ``:doc:`` references.\n\n``sphinxcontrib.getstart_sphinx.column``\n Add ``column`` directive to note columns.\n\n``sphinxcontrib.getstart_sphinx.footnote_relocator``\n Move footnote definitions to the bottom of each sections.\n\n``sphinxcontrib.getstart_sphinx.glossary_decorator``\n Make terms of glossaries bold.\n\n``sphinxcontrib.getstart_sphinx.oreilly_review_table``\n Convert tables in Re:VIEW output to original notation for\n O'Reilly Japan internal tools.\n\n\nUsage\n-----\n\nTo enable all extensions in this package, please add\n``sphinxcontrib.getstart_sphinx`` to your ``extensions`` list in conf.py::\n\n extensions = ['sphinxcontrib.getstart_sphinx']\n\nIf you want to enable specific extensions individually, please add its\nname to the list like bollow::\n\n extensions = ['sphinxcontrib.getstart_sphinx.better_docref',\n 'sphinxcontrib.getstart_sphinx.footnote_relocator']\n\nDirectives\n----------\n\nYou can use following directives:\n\n``column``\n A directive to note a column. It takes a title of column as an argument,\n and also takes body of column as content block.\n\n Example::\n\n .. column:: Sphinx\u3068Python\u306e\u30d0\u30fc\u30b8\u30e7\u30f3\u306e\u95a2\u4fc2\n\n \u30d0\u30fc\u30b8\u30e7\u30f31.5\u4ee5\u964d\u3001Sphinx\u3092\u52d5\u4f5c\u3055\u305b\u308b\u306b\u306f2.7\u3082\u3057\u304f\u306f3.4\u4ee5\u4e0a\u306e\n Python\u304c\u5fc5\u8981\u3067\u3059\u3002\n \u305d\u306e\u305f\u3081\u3001\u53e4\u3044Python\u304c\u30a4\u30f3\u30b9\u30c8\u30fc\u30eb\u3055\u308c\u308bCentOS 6.x\u7cfb\u306a\u3069\u306e\u30c7\u30a3\u30b9\u30c8\n \u30ea\u30d3\u30e5\u30fc\u30b7\u30e7\u30f3\u3067\u306f\u3001\u6700\u65b0\u306eSphinx\u304c\u5229\u7528\u3067\u304d\u307e\u305b\u3093\u3002\n\n\nSettings\n--------\n\nYou can configure following settings to arrange the behavior of the extension.\n\n``section_numbers``:\n A dict for mapping docname to section number text.\n This is used by ``better_docref`` extension to build a link title\n for document reference.\n\n Example::\n\n section_numbers = {\n 'ch01': '\u7b2c1\u7ae0',\n 'ch02': '\u7b2c2\u7ae0',\n 'ch03': '\u7b2c3\u7ae0',\n 'ch04': '\u7b2c4\u7ae0',\n 'ch05': '\u7b2c5\u7ae0',\n 'ch06': '\u7b2c6\u7ae0',\n 'appendix/references': '\u4ed8\u9332A',\n 'appendix/builders': '\u4ed8\u9332B',\n 'appendix/quickstart': '\u4ed8\u9332C',\n 'appendix/texlive': '\u4ed8\u9332D',\n 'appendix/make_sh': '\u4ed8\u9332E',\n 'appendix/markdown': '\u4ed8\u9332F',\n 'appendix/community': '\u4ed8\u9332G',\n }\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/getstart-sphinx/sphinxcontrib-getstart-sphinx", "keywords": "", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "sphinxcontrib-getstart-sphinx", "package_url": "https://pypi.org/project/sphinxcontrib-getstart-sphinx/", "platform": "any", "project_url": "https://pypi.org/project/sphinxcontrib-getstart-sphinx/", "project_urls": { "Homepage": "https://github.com/getstart-sphinx/sphinxcontrib-getstart-sphinx" }, "release_url": "https://pypi.org/project/sphinxcontrib-getstart-sphinx/1.0.0/", "requires_dist": null, "requires_python": "", "summary": "Sphinx extensions for \"Getting Started with Sphinx 2nd Edition\"", "version": "1.0.0" }, "last_serial": 3583185, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "a6220f8e314a288b1b875c05f49abded", "sha256": "de2511999381e2f2ed40e53bea18b559b8f49ffc80d0389bdabcbf622cd14cef" }, "downloads": -1, "filename": "sphinxcontrib_getstart_sphinx-1.0.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a6220f8e314a288b1b875c05f49abded", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 11929, "upload_time": "2018-02-15T03:10:53", "url": "https://files.pythonhosted.org/packages/1c/fa/81b27867548d044fd667db3daa446579f6b6216cdd8e5914eb92d900019b/sphinxcontrib_getstart_sphinx-1.0.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "aa4b17730a54842ed607fb53e3e6a415", "sha256": "7460f66b6dddc1a8df949ae45f6f28ff8b0b60d8b913043029329a95ae32797f" }, "downloads": -1, "filename": "sphinxcontrib-getstart-sphinx-1.0.0.tar.gz", "has_sig": false, "md5_digest": "aa4b17730a54842ed607fb53e3e6a415", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5809, "upload_time": "2018-02-15T03:10:51", "url": "https://files.pythonhosted.org/packages/55/29/9347e799b2d5fe82f57d2deff3cff0c749114fe475101eb299e4cbfcf3fc/sphinxcontrib-getstart-sphinx-1.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "a6220f8e314a288b1b875c05f49abded", "sha256": "de2511999381e2f2ed40e53bea18b559b8f49ffc80d0389bdabcbf622cd14cef" }, "downloads": -1, "filename": "sphinxcontrib_getstart_sphinx-1.0.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a6220f8e314a288b1b875c05f49abded", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 11929, "upload_time": "2018-02-15T03:10:53", "url": "https://files.pythonhosted.org/packages/1c/fa/81b27867548d044fd667db3daa446579f6b6216cdd8e5914eb92d900019b/sphinxcontrib_getstart_sphinx-1.0.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "aa4b17730a54842ed607fb53e3e6a415", "sha256": "7460f66b6dddc1a8df949ae45f6f28ff8b0b60d8b913043029329a95ae32797f" }, "downloads": -1, "filename": "sphinxcontrib-getstart-sphinx-1.0.0.tar.gz", "has_sig": false, "md5_digest": "aa4b17730a54842ed607fb53e3e6a415", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5809, "upload_time": "2018-02-15T03:10:51", "url": "https://files.pythonhosted.org/packages/55/29/9347e799b2d5fe82f57d2deff3cff0c749114fe475101eb299e4cbfcf3fc/sphinxcontrib-getstart-sphinx-1.0.0.tar.gz" } ] }