sphinxcontrib-getstart-sphinx
=============================
``sphinxcontrib-getstart-sphinx`` is a collection of Sphinx extensions to
build `Sphinxをはじめよう 第2版 (Getting Started with Sphinx 2nd Edition)`__.
__ https://www.oreilly.co.jp/books/9784873118192/
This package provides following extensions:
``sphinxcontrib.getstart_sphinx.better_docref``
Append section numbers to each ``:doc:`` references.
``sphinxcontrib.getstart_sphinx.column``
Add ``column`` directive to note columns.
``sphinxcontrib.getstart_sphinx.footnote_relocator``
Move footnote definitions to the bottom of each sections.
``sphinxcontrib.getstart_sphinx.glossary_decorator``
Make terms of glossaries bold.
``sphinxcontrib.getstart_sphinx.oreilly_review_table``
Convert tables in Re:VIEW output to original notation for
O'Reilly Japan internal tools.
Usage
-----
To enable all extensions in this package, please add
``sphinxcontrib.getstart_sphinx`` to your ``extensions`` list in conf.py::
extensions = ['sphinxcontrib.getstart_sphinx']
If you want to enable specific extensions individually, please add its
name to the list like bollow::
extensions = ['sphinxcontrib.getstart_sphinx.better_docref',
'sphinxcontrib.getstart_sphinx.footnote_relocator']
Directives
----------
You can use following directives:
``column``
A directive to note a column. It takes a title of column as an argument,
and also takes body of column as content block.
Example::
.. column:: SphinxとPythonのバージョンの関係
バージョン1.5以降、Sphinxを動作させるには2.7もしくは3.4以上の
Pythonが必要です。
そのため、古いPythonがインストールされるCentOS 6.x系などのディスト
リビューションでは、最新のSphinxが利用できません。
Settings
--------
You can configure following settings to arrange the behavior of the extension.
``section_numbers``:
A dict for mapping docname to section number text.
This is used by ``better_docref`` extension to build a link title
for document reference.
Example::
section_numbers = {
'ch01': '第1章',
'ch02': '第2章',
'ch03': '第3章',
'ch04': '第4章',
'ch05': '第5章',
'ch06': '第6章',
'appendix/references': '付録A',
'appendix/builders': '付録B',
'appendix/quickstart': '付録C',
'appendix/texlive': '付録D',
'appendix/make_sh': '付録E',
'appendix/markdown': '付録F',
'appendix/community': '付録G',
}
Raw data
{
"_id": null,
"home_page": "https://github.com/getstart-sphinx/sphinxcontrib-getstart-sphinx",
"name": "sphinxcontrib-getstart-sphinx",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Takeshi KOMIYA",
"author_email": "i.tkomiya@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ad/83/bbcc25caa798792e0ebd55b839ccb97ff78587f5e9271ea4c5fb2ff25190/sphinxcontrib-getstart-sphinx-1.2.0.tar.gz",
"platform": "any",
"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",
"bugtrack_url": null,
"license": "BSD",
"summary": "Sphinx extensions for \"Getting Started with Sphinx 2nd Edition\"",
"version": "1.2.0",
"project_urls": {
"Homepage": "https://github.com/getstart-sphinx/sphinxcontrib-getstart-sphinx"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "108eaf2a33510b507335b59cc3bd40a8865d336a4e72d63441d5f68eac4b6725",
"md5": "25e0064cb28cb1ae0b664727959d59e7",
"sha256": "cd849df08be163d27c45ff9913a7bf6a5f3f1d0d9e5fd9b92ca81e9b88d6609e"
},
"downloads": -1,
"filename": "sphinxcontrib_getstart_sphinx-1.2.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "25e0064cb28cb1ae0b664727959d59e7",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 8842,
"upload_time": "2024-04-25T08:20:50",
"upload_time_iso_8601": "2024-04-25T08:20:50.289560Z",
"url": "https://files.pythonhosted.org/packages/10/8e/af2a33510b507335b59cc3bd40a8865d336a4e72d63441d5f68eac4b6725/sphinxcontrib_getstart_sphinx-1.2.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ad83bbcc25caa798792e0ebd55b839ccb97ff78587f5e9271ea4c5fb2ff25190",
"md5": "f4d8abe916fc9c95c294ec2c8b92e2d6",
"sha256": "f2bd1e02db6bcde66208c8df6d3a2a4efb15ba7a6e8a65ad74ccbd640b012064"
},
"downloads": -1,
"filename": "sphinxcontrib-getstart-sphinx-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "f4d8abe916fc9c95c294ec2c8b92e2d6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6907,
"upload_time": "2024-04-25T08:20:52",
"upload_time_iso_8601": "2024-04-25T08:20:52.073016Z",
"url": "https://files.pythonhosted.org/packages/ad/83/bbcc25caa798792e0ebd55b839ccb97ff78587f5e9271ea4c5fb2ff25190/sphinxcontrib-getstart-sphinx-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-25 08:20:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "getstart-sphinx",
"github_project": "sphinxcontrib-getstart-sphinx",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "sphinxcontrib-getstart-sphinx"
}
JSON
