From d51c55494779a8c91b706a762b17c4a1b121b470 Mon Sep 17 00:00:00 2001 From: brandon s allbery kf8nh Date: Tue, 20 Aug 2024 19:06:35 -0400 Subject: [PATCH] index Paths and Paths_ (resp. for PackageInfo) These can currently be found by searching the documentation for `Paths_pkgname` and `PackageInfo_pkgname`, but you pretty much need to know that to begin with to find them. Add Sphinx index entries to make them more discoverable. --- doc/cabal-package-description-file.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/cabal-package-description-file.rst b/doc/cabal-package-description-file.rst index 839b2dc37db..6ae467b4774 100644 --- a/doc/cabal-package-description-file.rst +++ b/doc/cabal-package-description-file.rst @@ -3015,6 +3015,9 @@ Right now :pkg-field:`executable:main-is` modules are not supported on Accessing data files from package code -------------------------------------- +.. index:: Paths +.. index:: Paths_ + The placement on the target system of files listed in the :pkg-field:`data-files` field varies between systems, and in some cases one can even move packages around after installation @@ -3070,6 +3073,9 @@ the configured data directory for ``pretty-show`` is controlled with the Accessing the package version ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. index:: PackageInfo +.. index:: PackageInfo_ + The auto generated :file:`PackageInfo_{pkgname}` module exports the constant ``version ::`` `Version `__ which is defined as the version of your package as specified in the