search

chapel-lang / chapel

a Productive Parallel Programming Language
https://chapel-lang.org
Other
1.78k stars 419 forks source link

chpldoc feature request: support `:noindexentry:` #23071

Open jabraham17 opened 1 year ago

jabraham17 commented 1 year ago

Sphinx 3.2 added support for :noindexentry:, which is similar to :noindex: except that it allows cross-referencing using :ref:`...`.

We currently use :noindex: to prevent the internal modules from appearing in the index, but that prevents us from referencing them. So doing :mod:`owned <OwnedObject>` will fail since there is no entry for OwnedObject. But in this case, if we used :noindexentry:, we could use the cross-reference.

mppf commented 1 year ago

Would this work OK with the way we are embedding the internal module docs into the spec?

jabraham17 commented 1 year ago

Yes, this should work even when docs are embedded

mppf commented 6 months ago

A note from the sphinx docs


Changed in version 7.2:
    ...
    The directive option :noindexentry: was renamed to :no-index-entry:.
    ...