Skip to main content

sphinx index building tools

Project description


SearchBuildTargets Script

  • 指定パス(SearchPath) に対してフォルダとファイル名の走査を行う

  • 指定ファイル名(TargetFileName) があるフォルダパスを抽出 (target_path_list)

  • 指定の階層の深さ(target_path_list) に応じて buildPath の index.rst ファイルを追記する

    • 第1階層( SearchPath 直下のフォルダ名 ) index.rst の タイトルとして扱う

    • 第2階層 index.rst のサブタイトルとして扱う

    • index.rst に階層に応じて KeyFile名を追記する

    • ヘッドライン化する段階は headingdepth として数字で指定可能

  • target_path_list から .rst ファイル ( KeyFile )を生成する

    • TargetFileName の文字コードを SJIS -> UTF8

    • TargetFileName のカレントフォルダ名( KeyFileFolder )で TargetFileName のファイル名を置き換え

    • 拡張子を .rst にする

    • .rst ファイルの末尾に target_path_list へのリンクを追記する

      • :smblink: ディレクティブを利用する

    • 指定フォルダパス(saveto) パスにファイルを配置する


  • 以下のディレクティブを書くと、指定パス(tagSearchPath) に対してフォルダとファイル名の走査を行う:

    |  .. tagfinder::
    |    :file: tagFileName
    |    :tag: tagname
    |    :path: \\file\to
  • 指定ファイル名(tagFileName) にがあるフォルダパスを抽出 (tag_path_list)


    :tftag: tagname, tagname2, tagname3
    :desc: description
  • tag_path_list の各ファイルに対して以下の処理を行う



    `title <file://file/to/path/>`, "description"
    `title <file://file/to/path/>`, "description"
    `title <file://file/to/path/>`, "description"


pip install sphinxcontrib-indexbuilder


  1. Add 'sphinxcontrib.indexbuilder' to the extensions list in

extensions += [ 'sphinxcontrib.indexbuilder' ]


build index.rst and .rst files

Try this command to show usages

$ --help

Project details

Download files

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

Source Distribution

sphinxcontrib-indexbuilder-0.1.2.tar.gz (27.8 kB view hashes)

Uploaded source

Supported by

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