From c2138825110da285742af464a434e758c1cf6101 Mon Sep 17 00:00:00 2001 From: ridiculousfish Date: Sun, 16 Dec 2018 17:39:33 -0800 Subject: [PATCH] Switch command docs from \section to reStructuredText --- sphinx_doc_src/cmds/abbr.rst | 4 +++- sphinx_doc_src/cmds/alias.rst | 4 +++- sphinx_doc_src/cmds/and.rst | 4 +++- sphinx_doc_src/cmds/argparse.rst | 4 +++- sphinx_doc_src/cmds/begin.rst | 4 +++- sphinx_doc_src/cmds/bg.rst | 4 +++- sphinx_doc_src/cmds/bind.rst | 4 +++- sphinx_doc_src/cmds/block.rst | 4 +++- sphinx_doc_src/cmds/break.rst | 4 +++- sphinx_doc_src/cmds/breakpoint.rst | 4 +++- sphinx_doc_src/cmds/builtin.rst | 4 +++- sphinx_doc_src/cmds/case.rst | 4 +++- sphinx_doc_src/cmds/cd.rst | 4 +++- sphinx_doc_src/cmds/cdh.rst | 4 +++- sphinx_doc_src/cmds/command.rst | 4 +++- sphinx_doc_src/cmds/commandline.rst | 4 +++- sphinx_doc_src/cmds/complete.rst | 4 +++- sphinx_doc_src/cmds/contains.rst | 4 +++- sphinx_doc_src/cmds/continue.rst | 4 +++- sphinx_doc_src/cmds/count.rst | 4 +++- sphinx_doc_src/cmds/dirh.rst | 4 +++- sphinx_doc_src/cmds/dirs.rst | 4 +++- sphinx_doc_src/cmds/disown.rst | 4 +++- sphinx_doc_src/cmds/echo.rst | 4 +++- sphinx_doc_src/cmds/else.rst | 4 +++- sphinx_doc_src/cmds/emit.rst | 4 +++- sphinx_doc_src/cmds/end.rst | 4 +++- sphinx_doc_src/cmds/eval.rst | 4 +++- sphinx_doc_src/cmds/exec.rst | 4 +++- sphinx_doc_src/cmds/exit.rst | 4 +++- sphinx_doc_src/cmds/false.rst | 4 +++- sphinx_doc_src/cmds/fg.rst | 4 +++- sphinx_doc_src/cmds/fish.rst | 4 +++- sphinx_doc_src/cmds/fish_breakpoint_prompt.rst | 4 +++- sphinx_doc_src/cmds/fish_config.rst | 4 +++- sphinx_doc_src/cmds/fish_indent.rst | 4 +++- sphinx_doc_src/cmds/fish_key_reader.rst | 4 +++- sphinx_doc_src/cmds/fish_mode_prompt.rst | 4 +++- sphinx_doc_src/cmds/fish_opt.rst | 4 +++- sphinx_doc_src/cmds/fish_prompt.rst | 4 +++- sphinx_doc_src/cmds/fish_right_prompt.rst | 4 +++- sphinx_doc_src/cmds/fish_update_completions.rst | 4 +++- sphinx_doc_src/cmds/fish_vi_mode.rst | 4 +++- sphinx_doc_src/cmds/for.rst | 4 +++- sphinx_doc_src/cmds/funced.rst | 4 +++- sphinx_doc_src/cmds/funcsave.rst | 4 +++- sphinx_doc_src/cmds/function.rst | 4 +++- sphinx_doc_src/cmds/functions.rst | 4 +++- sphinx_doc_src/cmds/help.rst | 4 +++- sphinx_doc_src/cmds/history.rst | 4 +++- sphinx_doc_src/cmds/if.rst | 4 +++- sphinx_doc_src/cmds/isatty.rst | 4 +++- sphinx_doc_src/cmds/jobs.rst | 4 +++- sphinx_doc_src/cmds/math.rst | 4 +++- sphinx_doc_src/cmds/nextd.rst | 4 +++- sphinx_doc_src/cmds/not.rst | 4 +++- sphinx_doc_src/cmds/open.rst | 4 +++- sphinx_doc_src/cmds/or.rst | 4 +++- sphinx_doc_src/cmds/popd.rst | 4 +++- sphinx_doc_src/cmds/prevd.rst | 4 +++- sphinx_doc_src/cmds/printf.rst | 4 +++- sphinx_doc_src/cmds/prompt_pwd.rst | 4 +++- sphinx_doc_src/cmds/psub.rst | 4 +++- sphinx_doc_src/cmds/pushd.rst | 4 +++- sphinx_doc_src/cmds/pwd.rst | 4 +++- sphinx_doc_src/cmds/random.rst | 4 +++- sphinx_doc_src/cmds/read.rst | 4 +++- sphinx_doc_src/cmds/realpath.rst | 4 +++- sphinx_doc_src/cmds/return.rst | 4 +++- sphinx_doc_src/cmds/set.rst | 4 +++- sphinx_doc_src/cmds/set_color.rst | 4 +++- sphinx_doc_src/cmds/source.rst | 4 +++- sphinx_doc_src/cmds/status.rst | 4 +++- sphinx_doc_src/cmds/string.rst | 4 +++- sphinx_doc_src/cmds/suspend.rst | 4 +++- sphinx_doc_src/cmds/switch.rst | 4 +++- sphinx_doc_src/cmds/test.rst | 4 +++- sphinx_doc_src/cmds/trap.rst | 4 +++- sphinx_doc_src/cmds/true.rst | 4 +++- sphinx_doc_src/cmds/type.rst | 4 +++- sphinx_doc_src/cmds/ulimit.rst | 4 +++- sphinx_doc_src/cmds/umask.rst | 4 +++- sphinx_doc_src/cmds/vared.rst | 4 +++- sphinx_doc_src/cmds/wait.rst | 4 +++- sphinx_doc_src/cmds/while.rst | 4 +++- 85 files changed, 255 insertions(+), 85 deletions(-) diff --git a/sphinx_doc_src/cmds/abbr.rst b/sphinx_doc_src/cmds/abbr.rst index 76b0cf5c9..da3d67f3a 100644 --- a/sphinx_doc_src/cmds/abbr.rst +++ b/sphinx_doc_src/cmds/abbr.rst @@ -1,4 +1,6 @@ -\section abbr abbr - manage fish abbreviations +abbr - manage fish abbreviations +========================================== + \subsection abbr-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/alias.rst b/sphinx_doc_src/cmds/alias.rst index 606a05ec7..e7c0ca543 100644 --- a/sphinx_doc_src/cmds/alias.rst +++ b/sphinx_doc_src/cmds/alias.rst @@ -1,4 +1,6 @@ -\section alias alias - create a function +alias - create a function +========================================== + \subsection alias-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/and.rst b/sphinx_doc_src/cmds/and.rst index 3757847de..7abca07dd 100644 --- a/sphinx_doc_src/cmds/and.rst +++ b/sphinx_doc_src/cmds/and.rst @@ -1,4 +1,6 @@ -\section and and - conditionally execute a command +and - conditionally execute a command +========================================== + \subsection and-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/argparse.rst b/sphinx_doc_src/cmds/argparse.rst index 70278198a..d54815d30 100644 --- a/sphinx_doc_src/cmds/argparse.rst +++ b/sphinx_doc_src/cmds/argparse.rst @@ -1,4 +1,6 @@ -\section argparse argparse - parse options passed to a fish script or function +argparse - parse options passed to a fish script or function +========================================== + \subsection argparse-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/begin.rst b/sphinx_doc_src/cmds/begin.rst index dd008bda9..cc63c36c4 100644 --- a/sphinx_doc_src/cmds/begin.rst +++ b/sphinx_doc_src/cmds/begin.rst @@ -1,4 +1,6 @@ -\section begin begin - start a new block of code +begin - start a new block of code +========================================== + \subsection begin-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/bg.rst b/sphinx_doc_src/cmds/bg.rst index 13733f58e..10f40c89c 100644 --- a/sphinx_doc_src/cmds/bg.rst +++ b/sphinx_doc_src/cmds/bg.rst @@ -1,4 +1,6 @@ -\section bg bg - send jobs to background +bg - send jobs to background +========================================== + \subsection bg-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/bind.rst b/sphinx_doc_src/cmds/bind.rst index d778cd31e..db064b71a 100644 --- a/sphinx_doc_src/cmds/bind.rst +++ b/sphinx_doc_src/cmds/bind.rst @@ -1,4 +1,6 @@ -\section bind bind - handle fish key bindings +bind - handle fish key bindings +========================================== + \subsection bind-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/block.rst b/sphinx_doc_src/cmds/block.rst index 9fbbade83..5fe5dd3c9 100644 --- a/sphinx_doc_src/cmds/block.rst +++ b/sphinx_doc_src/cmds/block.rst @@ -1,4 +1,6 @@ -\section block block - temporarily block delivery of events +block - temporarily block delivery of events +========================================== + \subsection block-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/break.rst b/sphinx_doc_src/cmds/break.rst index 32672c09f..0b609955c 100644 --- a/sphinx_doc_src/cmds/break.rst +++ b/sphinx_doc_src/cmds/break.rst @@ -1,4 +1,6 @@ -\section break break - stop the current inner loop +break - stop the current inner loop +========================================== + \subsection break-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/breakpoint.rst b/sphinx_doc_src/cmds/breakpoint.rst index 8645c18dd..f0efffd85 100644 --- a/sphinx_doc_src/cmds/breakpoint.rst +++ b/sphinx_doc_src/cmds/breakpoint.rst @@ -1,4 +1,6 @@ -\section breakpoint breakpoint - Launch debug mode +breakpoint - Launch debug mode +========================================== + \subsection breakpoint-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/builtin.rst b/sphinx_doc_src/cmds/builtin.rst index 4c465ef18..90c512cec 100644 --- a/sphinx_doc_src/cmds/builtin.rst +++ b/sphinx_doc_src/cmds/builtin.rst @@ -1,4 +1,6 @@ -\section builtin builtin - run a builtin command +builtin - run a builtin command +========================================== + \subsection builtin-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/case.rst b/sphinx_doc_src/cmds/case.rst index 065c19e9b..8cfee4a76 100644 --- a/sphinx_doc_src/cmds/case.rst +++ b/sphinx_doc_src/cmds/case.rst @@ -1,4 +1,6 @@ -\section case case - conditionally execute a block of commands +case - conditionally execute a block of commands +========================================== + \subsection case-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/cd.rst b/sphinx_doc_src/cmds/cd.rst index 748f0c322..786f3c68b 100644 --- a/sphinx_doc_src/cmds/cd.rst +++ b/sphinx_doc_src/cmds/cd.rst @@ -1,4 +1,6 @@ -\section cd cd - change directory +cd - change directory +========================================== + \subsection cd-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/cdh.rst b/sphinx_doc_src/cmds/cdh.rst index 7d18acd86..295ab4ea3 100644 --- a/sphinx_doc_src/cmds/cdh.rst +++ b/sphinx_doc_src/cmds/cdh.rst @@ -1,4 +1,6 @@ -\section cdh cdh - change to a recently visited directory +cdh - change to a recently visited directory +========================================== + \subsection cdh-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/command.rst b/sphinx_doc_src/cmds/command.rst index e4f5c2cf6..0eafa8223 100644 --- a/sphinx_doc_src/cmds/command.rst +++ b/sphinx_doc_src/cmds/command.rst @@ -1,4 +1,6 @@ -\section command command - run a program +command - run a program +========================================== + \subsection command-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/commandline.rst b/sphinx_doc_src/cmds/commandline.rst index d97001709..ea2dad4f9 100644 --- a/sphinx_doc_src/cmds/commandline.rst +++ b/sphinx_doc_src/cmds/commandline.rst @@ -1,4 +1,6 @@ -\section commandline commandline - set or get the current command line buffer +commandline - set or get the current command line buffer +========================================== + \subsection commandline-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/complete.rst b/sphinx_doc_src/cmds/complete.rst index d295d1381..1e9d42316 100644 --- a/sphinx_doc_src/cmds/complete.rst +++ b/sphinx_doc_src/cmds/complete.rst @@ -1,4 +1,6 @@ -\section complete complete - edit command specific tab-completions +complete - edit command specific tab-completions +========================================== + \subsection complete-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/contains.rst b/sphinx_doc_src/cmds/contains.rst index c65292c09..cc3d8b1c3 100644 --- a/sphinx_doc_src/cmds/contains.rst +++ b/sphinx_doc_src/cmds/contains.rst @@ -1,4 +1,6 @@ -\section contains contains - test if a word is present in a list +contains - test if a word is present in a list +========================================== + \subsection contains-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/continue.rst b/sphinx_doc_src/cmds/continue.rst index 26346be6a..11c34bd10 100644 --- a/sphinx_doc_src/cmds/continue.rst +++ b/sphinx_doc_src/cmds/continue.rst @@ -1,4 +1,6 @@ -\section continue continue - skip the remainder of the current iteration of the current inner loop +continue - skip the remainder of the current iteration of the current inner loop +========================================== + \subsection continue-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/count.rst b/sphinx_doc_src/cmds/count.rst index bf11a6350..0b5659644 100644 --- a/sphinx_doc_src/cmds/count.rst +++ b/sphinx_doc_src/cmds/count.rst @@ -1,4 +1,6 @@ -\section count count - count the number of elements of an array +count - count the number of elements of an array +========================================== + \subsection count-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/dirh.rst b/sphinx_doc_src/cmds/dirh.rst index 77e03e185..bf94537ba 100644 --- a/sphinx_doc_src/cmds/dirh.rst +++ b/sphinx_doc_src/cmds/dirh.rst @@ -1,4 +1,6 @@ -\section dirh dirh - print directory history +dirh - print directory history +========================================== + \subsection dirh-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/dirs.rst b/sphinx_doc_src/cmds/dirs.rst index c3da6e84f..576d7de63 100644 --- a/sphinx_doc_src/cmds/dirs.rst +++ b/sphinx_doc_src/cmds/dirs.rst @@ -1,4 +1,6 @@ -\section dirs dirs - print directory stack +dirs - print directory stack +========================================== + \subsection dirs-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/disown.rst b/sphinx_doc_src/cmds/disown.rst index 45f5c025a..5047db5e5 100644 --- a/sphinx_doc_src/cmds/disown.rst +++ b/sphinx_doc_src/cmds/disown.rst @@ -1,4 +1,6 @@ -\section disown disown - remove a process from the list of jobs +disown - remove a process from the list of jobs +========================================== + \subsection disown-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/echo.rst b/sphinx_doc_src/cmds/echo.rst index 69d6df4ef..e01e9a63c 100644 --- a/sphinx_doc_src/cmds/echo.rst +++ b/sphinx_doc_src/cmds/echo.rst @@ -1,4 +1,6 @@ -\section echo echo - display a line of text +echo - display a line of text +========================================== + \subsection echo-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/else.rst b/sphinx_doc_src/cmds/else.rst index 76e0c61f3..d622d5750 100644 --- a/sphinx_doc_src/cmds/else.rst +++ b/sphinx_doc_src/cmds/else.rst @@ -1,4 +1,6 @@ -\section else else - execute command if a condition is not met +else - execute command if a condition is not met +========================================== + \subsection else-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/emit.rst b/sphinx_doc_src/cmds/emit.rst index 78f8e2467..58bbde1fa 100644 --- a/sphinx_doc_src/cmds/emit.rst +++ b/sphinx_doc_src/cmds/emit.rst @@ -1,4 +1,6 @@ -\section emit emit - Emit a generic event +emit - Emit a generic event +========================================== + \subsection emit-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/end.rst b/sphinx_doc_src/cmds/end.rst index 2b035930c..24eba81a6 100644 --- a/sphinx_doc_src/cmds/end.rst +++ b/sphinx_doc_src/cmds/end.rst @@ -1,4 +1,6 @@ -\section end end - end a block of commands. +end - end a block of commands. +========================================== + \subsection end-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/eval.rst b/sphinx_doc_src/cmds/eval.rst index 5e7785077..a5dd592b1 100644 --- a/sphinx_doc_src/cmds/eval.rst +++ b/sphinx_doc_src/cmds/eval.rst @@ -1,4 +1,6 @@ -\section eval eval - evaluate the specified commands +eval - evaluate the specified commands +========================================== + \subsection eval-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/exec.rst b/sphinx_doc_src/cmds/exec.rst index f8936101a..9a2f228f6 100644 --- a/sphinx_doc_src/cmds/exec.rst +++ b/sphinx_doc_src/cmds/exec.rst @@ -1,4 +1,6 @@ -\section exec exec - execute command in current process +exec - execute command in current process +========================================== + \subsection exec-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/exit.rst b/sphinx_doc_src/cmds/exit.rst index b780c4317..7baead27c 100644 --- a/sphinx_doc_src/cmds/exit.rst +++ b/sphinx_doc_src/cmds/exit.rst @@ -1,4 +1,6 @@ -\section exit exit - exit the shell +exit - exit the shell +========================================== + \subsection exit-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/false.rst b/sphinx_doc_src/cmds/false.rst index 1ce5a4619..cdf9b60d9 100644 --- a/sphinx_doc_src/cmds/false.rst +++ b/sphinx_doc_src/cmds/false.rst @@ -1,4 +1,6 @@ -\section false false - return an unsuccessful result +false - return an unsuccessful result +========================================== + \subsection false-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/fg.rst b/sphinx_doc_src/cmds/fg.rst index a27a0ad6b..518a2a5d8 100644 --- a/sphinx_doc_src/cmds/fg.rst +++ b/sphinx_doc_src/cmds/fg.rst @@ -1,4 +1,6 @@ -\section fg fg - bring job to foreground +fg - bring job to foreground +========================================== + \subsection fg-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/fish.rst b/sphinx_doc_src/cmds/fish.rst index 5e22e526d..152c310ce 100644 --- a/sphinx_doc_src/cmds/fish.rst +++ b/sphinx_doc_src/cmds/fish.rst @@ -1,4 +1,6 @@ -\section fish fish - the friendly interactive shell +fish - the friendly interactive shell +========================================== + \subsection fish-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/fish_breakpoint_prompt.rst b/sphinx_doc_src/cmds/fish_breakpoint_prompt.rst index b56c7e0ac..4a6b45ce5 100644 --- a/sphinx_doc_src/cmds/fish_breakpoint_prompt.rst +++ b/sphinx_doc_src/cmds/fish_breakpoint_prompt.rst @@ -1,4 +1,6 @@ -\section fish_breakpoint_prompt fish_breakpoint_prompt - define the appearance of the command line prompt when in the context of a `breakpoint` command +fish_breakpoint_prompt - define the appearance of the command line prompt when in the context of a `breakpoint` command +========================================== + \subsection fish_breakpoint_prompt-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/fish_config.rst b/sphinx_doc_src/cmds/fish_config.rst index 4fa242651..e4098ddbd 100644 --- a/sphinx_doc_src/cmds/fish_config.rst +++ b/sphinx_doc_src/cmds/fish_config.rst @@ -1,4 +1,6 @@ -\section fish_config fish_config - start the web-based configuration interface +fish_config - start the web-based configuration interface +========================================== + \subsection fish_config-description Description diff --git a/sphinx_doc_src/cmds/fish_indent.rst b/sphinx_doc_src/cmds/fish_indent.rst index 2cc429fb7..65eff46d8 100644 --- a/sphinx_doc_src/cmds/fish_indent.rst +++ b/sphinx_doc_src/cmds/fish_indent.rst @@ -1,4 +1,6 @@ -\section fish_indent fish_indent - indenter and prettifier +fish_indent - indenter and prettifier +========================================== + \subsection fish_indent-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/fish_key_reader.rst b/sphinx_doc_src/cmds/fish_key_reader.rst index d1d5db2ab..bba1fe1d1 100644 --- a/sphinx_doc_src/cmds/fish_key_reader.rst +++ b/sphinx_doc_src/cmds/fish_key_reader.rst @@ -1,4 +1,6 @@ -\section fish_key_reader fish_key_reader - explore what characters keyboard keys send +fish_key_reader - explore what characters keyboard keys send +========================================== + \subsection fish_key_reader-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/fish_mode_prompt.rst b/sphinx_doc_src/cmds/fish_mode_prompt.rst index c397d2c33..9c9f15a82 100644 --- a/sphinx_doc_src/cmds/fish_mode_prompt.rst +++ b/sphinx_doc_src/cmds/fish_mode_prompt.rst @@ -1,4 +1,6 @@ -\section fish_mode_prompt fish_mode_prompt - define the appearance of the mode indicator +fish_mode_prompt - define the appearance of the mode indicator +========================================== + \subsection fish_mode_prompt-synopsis Synopsis diff --git a/sphinx_doc_src/cmds/fish_opt.rst b/sphinx_doc_src/cmds/fish_opt.rst index 24967d24a..c6a81415d 100644 --- a/sphinx_doc_src/cmds/fish_opt.rst +++ b/sphinx_doc_src/cmds/fish_opt.rst @@ -1,4 +1,6 @@ -\section fish_opt fish_opt - create an option spec for the argparse command +fish_opt - create an option spec for the argparse command +========================================== + \subsection fish_opt-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/fish_prompt.rst b/sphinx_doc_src/cmds/fish_prompt.rst index 1beb5304e..0ee3ba550 100644 --- a/sphinx_doc_src/cmds/fish_prompt.rst +++ b/sphinx_doc_src/cmds/fish_prompt.rst @@ -1,4 +1,6 @@ -\section fish_prompt fish_prompt - define the appearance of the command line prompt +fish_prompt - define the appearance of the command line prompt +========================================== + \subsection fish_prompt-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/fish_right_prompt.rst b/sphinx_doc_src/cmds/fish_right_prompt.rst index 87de31139..a4fffa2af 100644 --- a/sphinx_doc_src/cmds/fish_right_prompt.rst +++ b/sphinx_doc_src/cmds/fish_right_prompt.rst @@ -1,4 +1,6 @@ -\section fish_right_prompt fish_right_prompt - define the appearance of the right-side command line prompt +fish_right_prompt - define the appearance of the right-side command line prompt +========================================== + \subsection fish_right_prompt-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/fish_update_completions.rst b/sphinx_doc_src/cmds/fish_update_completions.rst index 684dac0d8..12491c36d 100644 --- a/sphinx_doc_src/cmds/fish_update_completions.rst +++ b/sphinx_doc_src/cmds/fish_update_completions.rst @@ -1,4 +1,6 @@ -\section fish_update_completions fish_update_completions - Update completions using manual pages +fish_update_completions - Update completions using manual pages +========================================== + \subsection fish_update_completions-description Description diff --git a/sphinx_doc_src/cmds/fish_vi_mode.rst b/sphinx_doc_src/cmds/fish_vi_mode.rst index d39697c8f..bed5657f3 100644 --- a/sphinx_doc_src/cmds/fish_vi_mode.rst +++ b/sphinx_doc_src/cmds/fish_vi_mode.rst @@ -1,4 +1,6 @@ -\section fish_vi_mode fish_vi_mode - Enable vi mode +fish_vi_mode - Enable vi mode +========================================== + \subsection fish_vi_mode-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/for.rst b/sphinx_doc_src/cmds/for.rst index 508a3ac2d..4c30846cd 100644 --- a/sphinx_doc_src/cmds/for.rst +++ b/sphinx_doc_src/cmds/for.rst @@ -1,4 +1,6 @@ -\section for for - perform a set of commands multiple times. +for - perform a set of commands multiple times. +========================================== + \subsection for-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/funced.rst b/sphinx_doc_src/cmds/funced.rst index b8a7db530..38709da6f 100644 --- a/sphinx_doc_src/cmds/funced.rst +++ b/sphinx_doc_src/cmds/funced.rst @@ -1,4 +1,6 @@ -\section funced funced - edit a function interactively +funced - edit a function interactively +========================================== + \subsection funced-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/funcsave.rst b/sphinx_doc_src/cmds/funcsave.rst index 32b3f4f31..bd29e62f5 100644 --- a/sphinx_doc_src/cmds/funcsave.rst +++ b/sphinx_doc_src/cmds/funcsave.rst @@ -1,4 +1,6 @@ -\section funcsave funcsave - save the definition of a function to the user's autoload directory +funcsave - save the definition of a function to the user's autoload directory +========================================== + \subsection funcsave-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/function.rst b/sphinx_doc_src/cmds/function.rst index b6db339e9..e892361c7 100644 --- a/sphinx_doc_src/cmds/function.rst +++ b/sphinx_doc_src/cmds/function.rst @@ -1,4 +1,6 @@ -\section function function - create a function +function - create a function +========================================== + \subsection function-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/functions.rst b/sphinx_doc_src/cmds/functions.rst index 2b4b067e8..5321fb3f5 100644 --- a/sphinx_doc_src/cmds/functions.rst +++ b/sphinx_doc_src/cmds/functions.rst @@ -1,4 +1,6 @@ -\section functions functions - print or erase functions +functions - print or erase functions +========================================== + \subsection functions-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/help.rst b/sphinx_doc_src/cmds/help.rst index 9665dba27..a033ed883 100644 --- a/sphinx_doc_src/cmds/help.rst +++ b/sphinx_doc_src/cmds/help.rst @@ -1,4 +1,6 @@ -\section help help - display fish documentation +help - display fish documentation +========================================== + \subsection help-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/history.rst b/sphinx_doc_src/cmds/history.rst index 192bfd191..06a45b031 100644 --- a/sphinx_doc_src/cmds/history.rst +++ b/sphinx_doc_src/cmds/history.rst @@ -1,4 +1,6 @@ -\section history history - Show and manipulate command history +history - Show and manipulate command history +========================================== + \subsection history-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/if.rst b/sphinx_doc_src/cmds/if.rst index 61ba387c1..ded05f8c8 100644 --- a/sphinx_doc_src/cmds/if.rst +++ b/sphinx_doc_src/cmds/if.rst @@ -1,4 +1,6 @@ -\section if if - conditionally execute a command +if - conditionally execute a command +========================================== + \subsection if-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/isatty.rst b/sphinx_doc_src/cmds/isatty.rst index f6ab500e6..192197f63 100644 --- a/sphinx_doc_src/cmds/isatty.rst +++ b/sphinx_doc_src/cmds/isatty.rst @@ -1,4 +1,6 @@ -\section isatty isatty - test if a file descriptor is a tty. +isatty - test if a file descriptor is a tty. +========================================== + \subsection isatty-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/jobs.rst b/sphinx_doc_src/cmds/jobs.rst index df4fd9f10..ae930e1eb 100644 --- a/sphinx_doc_src/cmds/jobs.rst +++ b/sphinx_doc_src/cmds/jobs.rst @@ -1,4 +1,6 @@ -\section jobs jobs - print currently running jobs +jobs - print currently running jobs +========================================== + \subsection jobs-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/math.rst b/sphinx_doc_src/cmds/math.rst index 790933a93..09d239153 100644 --- a/sphinx_doc_src/cmds/math.rst +++ b/sphinx_doc_src/cmds/math.rst @@ -1,4 +1,6 @@ -\section math math - Perform mathematics calculations +math - Perform mathematics calculations +========================================== + \subsection math-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/nextd.rst b/sphinx_doc_src/cmds/nextd.rst index 61e01f1ef..4afb09687 100644 --- a/sphinx_doc_src/cmds/nextd.rst +++ b/sphinx_doc_src/cmds/nextd.rst @@ -1,4 +1,6 @@ -\section nextd nextd - move forward through directory history +nextd - move forward through directory history +========================================== + \subsection nextd-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/not.rst b/sphinx_doc_src/cmds/not.rst index 7848d2dc9..38a5eac83 100644 --- a/sphinx_doc_src/cmds/not.rst +++ b/sphinx_doc_src/cmds/not.rst @@ -1,4 +1,6 @@ -\section not not - negate the exit status of a job +not - negate the exit status of a job +========================================== + \subsection not-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/open.rst b/sphinx_doc_src/cmds/open.rst index 7207fc172..4c63394f4 100644 --- a/sphinx_doc_src/cmds/open.rst +++ b/sphinx_doc_src/cmds/open.rst @@ -1,4 +1,6 @@ -\section open open - open file in its default application +open - open file in its default application +========================================== + \subsection open-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/or.rst b/sphinx_doc_src/cmds/or.rst index b79e707d6..a7dd07967 100644 --- a/sphinx_doc_src/cmds/or.rst +++ b/sphinx_doc_src/cmds/or.rst @@ -1,4 +1,6 @@ -\section or or - conditionally execute a command +or - conditionally execute a command +========================================== + \subsection or-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/popd.rst b/sphinx_doc_src/cmds/popd.rst index 93dd4da37..f542a0acb 100644 --- a/sphinx_doc_src/cmds/popd.rst +++ b/sphinx_doc_src/cmds/popd.rst @@ -1,4 +1,6 @@ -\section popd popd - move through directory stack +popd - move through directory stack +========================================== + \subsection popd-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/prevd.rst b/sphinx_doc_src/cmds/prevd.rst index 191d95890..e94e87c36 100644 --- a/sphinx_doc_src/cmds/prevd.rst +++ b/sphinx_doc_src/cmds/prevd.rst @@ -1,4 +1,6 @@ -\section prevd prevd - move backward through directory history +prevd - move backward through directory history +========================================== + \subsection prevd-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/printf.rst b/sphinx_doc_src/cmds/printf.rst index 49fb0ad6a..e943c92f4 100644 --- a/sphinx_doc_src/cmds/printf.rst +++ b/sphinx_doc_src/cmds/printf.rst @@ -1,4 +1,6 @@ -\section printf printf - display text according to a format string +printf - display text according to a format string +========================================== + \subsection printf-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/prompt_pwd.rst b/sphinx_doc_src/cmds/prompt_pwd.rst index 0eafbf994..f8587af3f 100644 --- a/sphinx_doc_src/cmds/prompt_pwd.rst +++ b/sphinx_doc_src/cmds/prompt_pwd.rst @@ -1,4 +1,6 @@ -\section prompt_pwd prompt_pwd - Print pwd suitable for prompt +prompt_pwd - Print pwd suitable for prompt +========================================== + \subsection prompt_pwd-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/psub.rst b/sphinx_doc_src/cmds/psub.rst index d0c59e0ac..830f2f3ee 100644 --- a/sphinx_doc_src/cmds/psub.rst +++ b/sphinx_doc_src/cmds/psub.rst @@ -1,4 +1,6 @@ -\section psub psub - perform process substitution +psub - perform process substitution +========================================== + \subsection psub-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/pushd.rst b/sphinx_doc_src/cmds/pushd.rst index 43d62c6dd..a07606756 100644 --- a/sphinx_doc_src/cmds/pushd.rst +++ b/sphinx_doc_src/cmds/pushd.rst @@ -1,4 +1,6 @@ -\section pushd pushd - push directory to directory stack +pushd - push directory to directory stack +========================================== + \subsection pushd-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/pwd.rst b/sphinx_doc_src/cmds/pwd.rst index b3860498e..816f2f373 100644 --- a/sphinx_doc_src/cmds/pwd.rst +++ b/sphinx_doc_src/cmds/pwd.rst @@ -1,4 +1,6 @@ -\section pwd pwd - output the current working directory +pwd - output the current working directory +========================================== + \subsection pwd-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/random.rst b/sphinx_doc_src/cmds/random.rst index 28f140152..6f6cc25d5 100644 --- a/sphinx_doc_src/cmds/random.rst +++ b/sphinx_doc_src/cmds/random.rst @@ -1,4 +1,6 @@ -\section random random - generate random number +random - generate random number +========================================== + \subsection random-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/read.rst b/sphinx_doc_src/cmds/read.rst index c898cca59..9a848d28e 100644 --- a/sphinx_doc_src/cmds/read.rst +++ b/sphinx_doc_src/cmds/read.rst @@ -1,4 +1,6 @@ -\section read read - read line of input into variables +read - read line of input into variables +========================================== + \subsection read-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/realpath.rst b/sphinx_doc_src/cmds/realpath.rst index 35e6503a3..9f2bb9bcc 100644 --- a/sphinx_doc_src/cmds/realpath.rst +++ b/sphinx_doc_src/cmds/realpath.rst @@ -1,4 +1,6 @@ -\section realpath realpath - Convert a path to an absolute path without symlinks +realpath - Convert a path to an absolute path without symlinks +========================================== + \subsection realpath-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/return.rst b/sphinx_doc_src/cmds/return.rst index af4ca9aeb..328d397d2 100644 --- a/sphinx_doc_src/cmds/return.rst +++ b/sphinx_doc_src/cmds/return.rst @@ -1,4 +1,6 @@ -\section return return - stop the current inner function +return - stop the current inner function +========================================== + \subsection return-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/set.rst b/sphinx_doc_src/cmds/set.rst index fca3bf170..4a85f539a 100644 --- a/sphinx_doc_src/cmds/set.rst +++ b/sphinx_doc_src/cmds/set.rst @@ -1,4 +1,6 @@ -\section set set - display and change shell variables. +set - display and change shell variables. +========================================== + \subsection set-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/set_color.rst b/sphinx_doc_src/cmds/set_color.rst index 8af576458..a5aede87b 100644 --- a/sphinx_doc_src/cmds/set_color.rst +++ b/sphinx_doc_src/cmds/set_color.rst @@ -1,4 +1,6 @@ -\section set_color set_color - set the terminal color +set_color - set the terminal color +========================================== + \subsection set_color-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/source.rst b/sphinx_doc_src/cmds/source.rst index 7b32654ee..8fc4c8f86 100644 --- a/sphinx_doc_src/cmds/source.rst +++ b/sphinx_doc_src/cmds/source.rst @@ -1,4 +1,6 @@ -\section source source - evaluate contents of file. +source - evaluate contents of file. +========================================== + \subsection source-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/status.rst b/sphinx_doc_src/cmds/status.rst index b69996d57..b3c6de020 100644 --- a/sphinx_doc_src/cmds/status.rst +++ b/sphinx_doc_src/cmds/status.rst @@ -1,4 +1,6 @@ -\section status status - query fish runtime information +status - query fish runtime information +========================================== + \subsection status-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/string.rst b/sphinx_doc_src/cmds/string.rst index 52bca9445..a798de5c5 100644 --- a/sphinx_doc_src/cmds/string.rst +++ b/sphinx_doc_src/cmds/string.rst @@ -1,4 +1,6 @@ -\section string string - manipulate strings +string - manipulate strings +========================================== + \subsection string-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/suspend.rst b/sphinx_doc_src/cmds/suspend.rst index 0fc9485b6..f96e47f9b 100644 --- a/sphinx_doc_src/cmds/suspend.rst +++ b/sphinx_doc_src/cmds/suspend.rst @@ -1,4 +1,6 @@ -\section suspend suspend - suspend the current shell +suspend - suspend the current shell +========================================== + \subsection suspend-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/switch.rst b/sphinx_doc_src/cmds/switch.rst index 9bba2bb0d..7ecf7b60b 100644 --- a/sphinx_doc_src/cmds/switch.rst +++ b/sphinx_doc_src/cmds/switch.rst @@ -1,4 +1,6 @@ -\section switch switch - conditionally execute a block of commands +switch - conditionally execute a block of commands +========================================== + \subsection switch-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/test.rst b/sphinx_doc_src/cmds/test.rst index 1f54f1b00..4ea0f5caf 100644 --- a/sphinx_doc_src/cmds/test.rst +++ b/sphinx_doc_src/cmds/test.rst @@ -1,4 +1,6 @@ -\section test test - perform tests on files and text +test - perform tests on files and text +========================================== + \subsection test-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/trap.rst b/sphinx_doc_src/cmds/trap.rst index 3c8d8a963..7aabf5ed0 100644 --- a/sphinx_doc_src/cmds/trap.rst +++ b/sphinx_doc_src/cmds/trap.rst @@ -1,4 +1,6 @@ -\section trap trap - perform an action when the shell receives a signal +trap - perform an action when the shell receives a signal +========================================== + \subsection trap-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/true.rst b/sphinx_doc_src/cmds/true.rst index 1418c1ed4..00c06561f 100644 --- a/sphinx_doc_src/cmds/true.rst +++ b/sphinx_doc_src/cmds/true.rst @@ -1,4 +1,6 @@ -\section true true - return a successful result +true - return a successful result +========================================== + \subsection true-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/type.rst b/sphinx_doc_src/cmds/type.rst index 2d1a56abf..fa4096243 100644 --- a/sphinx_doc_src/cmds/type.rst +++ b/sphinx_doc_src/cmds/type.rst @@ -1,4 +1,6 @@ -\section type type - indicate how a command would be interpreted +type - indicate how a command would be interpreted +========================================== + \subsection type-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/ulimit.rst b/sphinx_doc_src/cmds/ulimit.rst index 86ffe2b6f..ca822cb6d 100644 --- a/sphinx_doc_src/cmds/ulimit.rst +++ b/sphinx_doc_src/cmds/ulimit.rst @@ -1,4 +1,6 @@ -\section ulimit ulimit - set or get resource usage limits +ulimit - set or get resource usage limits +========================================== + \subsection ulimit-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/umask.rst b/sphinx_doc_src/cmds/umask.rst index 7429d8a9e..23ff022a4 100644 --- a/sphinx_doc_src/cmds/umask.rst +++ b/sphinx_doc_src/cmds/umask.rst @@ -1,4 +1,6 @@ -\section umask umask - set or get the file creation mode mask +umask - set or get the file creation mode mask +========================================== + \subsection umask-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/vared.rst b/sphinx_doc_src/cmds/vared.rst index 352357872..2687c1bf6 100644 --- a/sphinx_doc_src/cmds/vared.rst +++ b/sphinx_doc_src/cmds/vared.rst @@ -1,4 +1,6 @@ -\section vared vared - interactively edit the value of an environment variable +vared - interactively edit the value of an environment variable +========================================== + \subsection vared-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/wait.rst b/sphinx_doc_src/cmds/wait.rst index 57aa27318..9d1565273 100644 --- a/sphinx_doc_src/cmds/wait.rst +++ b/sphinx_doc_src/cmds/wait.rst @@ -1,4 +1,6 @@ -\section wait wait - wait for jobs to complete +wait - wait for jobs to complete +========================================== + \subsection wait-synopsis Synopsis \fish{synopsis} diff --git a/sphinx_doc_src/cmds/while.rst b/sphinx_doc_src/cmds/while.rst index 38338792f..a1511a43f 100644 --- a/sphinx_doc_src/cmds/while.rst +++ b/sphinx_doc_src/cmds/while.rst @@ -1,4 +1,6 @@ -\section while while - perform a command multiple times +while - perform a command multiple times +========================================== + \subsection while-synopsis Synopsis \fish{synopsis}