Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

sphinx index building tools

Project description

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) パスにファイルを配置する

tagfinder

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

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

    指定ファイルの書き方:

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

    ファイル内に指定の文字列(tagname)が存在するか検索

    存在する場合は、当該ファイルの一行目をタイトル、フォルダパスとして取得し、リンクリスト化:

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

Installation

pip install sphinxcontrib-indexbuilder

Configuration

  1. Add 'sphinxcontrib.indexbuilder' to the extensions list in conf.py.
extensions += [ 'sphinxcontrib.indexbuilder' ]

Usage

build index.rst and .rst files

Try this command to show usages

$ SearchBuildTargets.py --help

Project details


Release history Release notifications

This version

0.1.2

Download files

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

Files for sphinxcontrib-indexbuilder, version 0.1.2
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib-indexbuilder-0.1.2.tar.gz (27.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page