Skip to main content

A sphinx extension to replace the IndexEntries class.

Project description

Documentation Status Build Status (CircleCI) Code Coverage Status (Codecov) BSD 2 Clause

A sphinx extension to replace the IndexEntries class.

  • Sphindexer = Sphinx + Indexer

THE GOAL

  • It’s to become the IndexEntries class.

  • It has the extention for kana_text.

FEATURE

  • Even when editing glossary with index_key, make clean is not necessary.

  • See/seealso appears at the first.

  • When there are multiple functions with the same name, the first one will not be left out.

  • It is relatively easy to customize the display order to your liking.

    • You must be able to develop sphinx extensions.

USAGE

conf.py

extensions = ['sphindexer']

build ( without sphindexer ):

$ make html

build ( with sphindexer ):

$ make idxr

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

sphindexer-0.11.0.tar.gz (10.5 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page