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.12.2.tar.gz (19.4 kB view details)

Uploaded Source

File details

Details for the file sphindexer-0.12.2.tar.gz.

File metadata

  • Download URL: sphindexer-0.12.2.tar.gz
  • Upload date:
  • Size: 19.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for sphindexer-0.12.2.tar.gz
Algorithm Hash digest
SHA256 ad35724c01ad0cb48b3e59728f7841fdc3c7ddcb7ec375683aaf4be75a5ec262
MD5 b796ad05699c31e35e074f9d6a022ea6
BLAKE2b-256 4fb5d1c889059aea2143ce55bc6ae2b1e054a1c074801cacc6a67431fe43a06f

See more details on using hashes here.

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