Skip to content

Add links to each known program in docs #12403

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
philderbeast wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add links to each known program in docs #12403

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions doc/_static/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
/* The theme stops text in table cells from wrapping, except within inline
* literals. Instead, wrap the text and keep each literal on one line. */
.wy-table-responsive table td {
white-space: normal;
}

.rst-content table.docutils code.literal {
white-space: nowrap;
}
3 changes: 2 additions & 1 deletion doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,8 @@
html_title = "Cabal {} User's Guide".format(release)
html_short_title = "Cabal %s User's Guide" % release
html_logo = 'images/Cabal-dark.png'
html_static_path = ['images']
html_static_path = ['images', '_static']
html_css_files = ['custom.css']
# Convert quotes and dashes to typographically correct entities
html_use_smartypants = True
html_show_copyright = True
Expand Down
41 changes: 23 additions & 18 deletions doc/config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,47 +325,52 @@ The list of known programs is:
+-----------------------+------------------------------------------------------------------------------------------------------------------------------------+
| Program | Notes |
+=======================+====================================================================================================================================+
| ``alex`` | `<https://haskell-alex.readthedocs.io/en/latest/>`_ |
| ``alex`` | `Alex User Guide <https://haskell-alex.readthedocs.io/en/latest/>`_ |
+-----------------------+------------------------------------------------------------------------------------------------------------------------------------+
| ``ar`` | Usually provided by GHC's ``"ar command"`` entry in ``ghc --info``. Note this might refer to ``llvm-ar`` instead of GNU's ``ar``. |
+-----------------------+------------------------------------------------------------------------------------------------------------------------------------+
| ``c2hs`` | `<https://hackage.haskell.org/package/c2hs>`_ |
| ``c2hs`` | :hackage-pkg:`c2hs on Hackage <c2hs>` |
+-----------------------+------------------------------------------------------------------------------------------------------------------------------------+
| ``doctest`` | `<https://hackage.haskell.org/package/doctest>`_ |
| ``cpphs`` | :hackage-pkg:`cpphs on Hackage <cpphs>` |
+-----------------------+------------------------------------------------------------------------------------------------------------------------------------+
| ``doctest`` | :hackage-pkg:`doctest on Hackage <doctest>` |
+-----------------------+------------------------------------------------------------------------------------------------------------------------------------+
| ``gcc`` | Usually provided by GHC's ``"C compiler command"`` entry in ``ghc --info``. Note this might refer to ``clang`` instead of ``gcc``. |
+-----------------------+------------------------------------------------------------------------------------------------------------------------------------+
| ``ghc`` | |
| ``ghc`` | `GHC User's Guide <https://downloads.haskell.org/ghc/latest/docs/users_guide/>`_ |
+-----------------------+------------------------------------------------------------------------------------------------------------------------------------+
| ``ghc-pkg`` | |
| ``ghc-pkg`` | `GHC User's Guide: Package management |
| | <https://downloads.haskell.org/ghc/latest/docs/users_guide/packages.html#package-management-the-ghc-pkg-command>`_ |
+-----------------------+------------------------------------------------------------------------------------------------------------------------------------+
| ``ghcjs`` | |
| ``ghcjs`` | `GHCJS on GitHub <https://github.com/ghcjs/ghcjs>`_ |
+-----------------------+------------------------------------------------------------------------------------------------------------------------------------+
| ``ghcjs-pkg`` | |
| ``ghcjs-pkg`` | The ``ghc-pkg`` of GHCJS, see `GHCJS on GitHub`_. |
+-----------------------+------------------------------------------------------------------------------------------------------------------------------------+
| ``haddock`` | `<https://haskell-haddock.readthedocs.io/latest/>`_ |
| ``haddock`` | `Haddock User Guide <https://haskell-haddock.readthedocs.io/latest/>`_ |
+-----------------------+------------------------------------------------------------------------------------------------------------------------------------+
| ``happy`` | `<https://haskell-happy.readthedocs.io/en/latest/>`_ |
| ``happy`` | `Happy User Guide <https://haskell-happy.readthedocs.io/en/latest/>`_ |
+-----------------------+------------------------------------------------------------------------------------------------------------------------------------+
| ``hpc`` | `<https://hackage.haskell.org/package/hpc>`_ |
| ``hpc`` | :hackage-pkg:`hpc on Hackage <hpc>` |
+-----------------------+------------------------------------------------------------------------------------------------------------------------------------+
| ``hsc2hs`` | `<https://hackage.haskell.org/package/hsc2hs>`_ |
| ``hsc2hs`` | :hackage-pkg:`hsc2hs on Hackage <hsc2hs>` |
+-----------------------+------------------------------------------------------------------------------------------------------------------------------------+
| ``hscolour`` | `<https://hackage.haskell.org/package/hscolour>`_ |
| ``hscolour`` | :hackage-pkg:`hscolour on Hackage <hscolour>` |
+-----------------------+------------------------------------------------------------------------------------------------------------------------------------+
| ``jhc`` | `<http://repetae.net/computer/jhc/>`_ |
| ``jhc`` | `jhc homepage <http://repetae.net/computer/jhc/>`_ |
+-----------------------+------------------------------------------------------------------------------------------------------------------------------------+
| ``ld`` | Usually provided by GHC's ``"ld command"`` entry in ``ghc --info``. |
+-----------------------+------------------------------------------------------------------------------------------------------------------------------------+
| ``pkg-config`` | |
| ``pkg-config`` | Used to find the dependencies listed in :pkg-field:`pkgconfig-depends`, see the |
| | `pkg-config homepage <https://www.freedesktop.org/wiki/Software/pkg-config/>`_. |
+-----------------------+------------------------------------------------------------------------------------------------------------------------------------+
| ``runghc`` | |
| ``runghc`` | `GHC User's Guide: Using runghc <https://downloads.haskell.org/ghc/latest/docs/users_guide/runghc.html>`_ |
+-----------------------+------------------------------------------------------------------------------------------------------------------------------------+
| ``strip`` | |
| ``strip`` | Used when installing if :cfg-field:`executable-stripping` or :cfg-field:`library-stripping` is enabled, see |
| | `GNU strip <https://sourceware.org/binutils/docs/binutils/strip.html>`_. |
+-----------------------+------------------------------------------------------------------------------------------------------------------------------------+
| ``tar`` | |
| ``tar`` | Used by :ref:`setup-sdist` to create the source tarball, see `GNU tar <https://www.gnu.org/software/tar/>`_. |
+-----------------------+------------------------------------------------------------------------------------------------------------------------------------+
| ``uhc`` | `<https://github.com/UU-ComputerScience/uhc>`_ |
| ``uhc`` | `UHC on GitHub <https://github.com/UU-ComputerScience/uhc>`_ |
+-----------------------+------------------------------------------------------------------------------------------------------------------------------------+

.. warning::
Expand Down
Loading