Skip to content

Commit

Permalink
index Paths and Paths_ (resp. for PackageInfo)
Browse files Browse the repository at this point in the history
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.

(cherry picked from commit d51c554)
  • Loading branch information
geekosaur authored and mergify[bot] committed Aug 30, 2024
1 parent ef670f2 commit c359eca
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions doc/cabal-package-description-file.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2965,6 +2965,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
Expand Down Expand Up @@ -3020,6 +3023,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 <http://hackage.haskell.org/package/base/docs/Data-Version.html>`__
which is defined as the version of your package as specified in the
Expand Down

0 comments on commit c359eca

Please sign in to comment.