phpDocumentor / phpDocumentor/guides

Support Index generation (Glossary)

Open
#921 1 comment 0 reactions 1 assignee View on GitHub

@linawolf is already working on this.

Since May 28, 2026.

feature
Dominant language
PHP
Stars
36
Forks
22
Avg merge
2d 2h
Merged PRs (30d)
24

Description

Feature request

Sphinx allows to create indexes like this:

https://docs.typo3.org/m/typo3/reference-coreapi/12.4/en-us/genindex.html

This interprets RST tagged indices:

.. index:: 
   XLIFF; Files
   File; XLIFF

and with that information creates a reference index as "genindex.html".

Having an index like this helps readers of documentation to easily see which terms have been referenced on which page, where manual indexes have been placed.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.