Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

Sphinx extensions for "Getting Started with Sphinx 2nd Edition"

Project description

sphinxcontrib-getstart-sphinx is a collection of Sphinx extensions to build Sphinxをはじめよう 第2版 (Getting Started with Sphinx 2nd Edition).

This package provides following extensions:

Append section numbers to each :doc: references.
Add column directive to note columns.
Move footnote definitions to the bottom of each sections.
Make terms of glossaries bold.
Convert tables in Re:VIEW output to original notation for O’Reilly Japan internal tools.


To enable all extensions in this package, please add sphinxcontrib.getstart_sphinx to your extensions list in

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',


You can use following directives:


A directive to note a column. It takes a title of column as an argument, and also takes body of column as content block.


.. column:: SphinxとPythonのバージョンの関係

   そのため、古いPythonがインストールされるCentOS 6.x系などのディスト


You can configure following settings to arrange the behavior of the extension.


A dict for mapping docname to section number text. This is used by better_docref extension to build a link title for document reference.


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',

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinxcontrib-getstart-sphinx, version 1.1.0
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib_getstart_sphinx-1.1.0-py2.py3-none-any.whl (8.6 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size sphinxcontrib-getstart-sphinx-1.1.0.tar.gz (7.1 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page