h/fish-shell
1
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2026-06-01 04:41:14 -03:00
Code Issues Packages Projects Releases Wiki Activity

docs: Use :doc: role when linking to commands

Browse Source 
This makes it so we link to the very top of the document instead of a
special anchor we manually include.

So clicking e.g. :doc:`string <cmds/string>` will link you to
cmds/string.html instead of cmds/string.html#cmd-string.

I would love to have a way to say "this document from the root of the
document path", but that doesn't appear to work, I tried
`/cmds/string`.

So we'll just have to use cmds/string in normal documents and plain
`string` from other commands.
This commit is contained in:
Fabian Boehm
2022-09-23 19:57:49 +02:00
parent bc4e7c3fea
commit 38b24c2325
64 changed files with 262 additions and 262 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc_src/cmds/dirs.rst
View File

@@ -13,7 +13,7 @@ Synopsis
Description
-----------
``dirs`` prints the current :ref:`directory stack <directory-stack>`, as created by :ref:`pushd <cmd-pushd>` and modified by :ref:`popd <cmd-popd>`.
``dirs`` prints the current :ref:`directory stack <directory-stack>`, as created by :doc:`pushd <pushd>` and modified by :doc:`popd <popd>`.
The following options are available:
@@ -28,4 +28,4 @@ The following options are available:
See Also
--------
- the :ref:`cdh <cmd-cdh>` command, which provides a more intuitive way to navigate to recently visited directories.
- the :doc:`cdh <cdh>` command, which provides a more intuitive way to navigate to recently visited directories.