search

markstory / sphinxcontrib-phpdomain

A PHP domain for sphinx. Allows you to annotate PHP objects in your sphinx docs.
Other
19 stars 15 forks source link

Support noindexentry option for domain objects #48

Closed n-peugnet closed 1 year ago

n-peugnet commented 1 year ago

This option allows to disable the creation of index entries for targeted objects. See https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#basic-markup

Inspired from this change.

mvorisek commented 1 year ago

Starting with sphinx>5 the domain objects are added to an index. Can this be disabled globally/in conf.py?

n-peugnet commented 1 year ago

Starting with sphinx>5 the domain objects are added to an index. Can this be disabled globally/in conf.py?

Maybe this option would do what you want (didn't test it myself). But it is only for the HTML builder.

mvorisek commented 1 year ago

Starting with sphinx>5 the domain objects are added to an index. Can this be disabled globally/in conf.py?

Maybe this option would do what you want (didn't test it myself). But it is only for the HTML builder.

Thank you, unfortunately the html_domain_indices options controls if php-modindex.html file is created or not.

Do you know is there is any possibility to specify "domain defaults" in conf.py?