github-mirror/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2024-12-12 08:33:45 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
11,459 Commits 36 Branches 80 Tags 104 MiB
cd2be9c22f
Commit Graph

242 Commits

Author SHA1 Message Date
Fabian Homborg
b8570a9e8a docs/cmds/string: Improve synopsis 
This both formats it as a code-block, and adds the synopsis of each
subcommand to the corresponding section again so you don't need to
scroll back-and-forth so much.

[ci skip]
 2019-03-29 20:11:23 +01:00
Fabian Homborg
ebc0bee404 docs: Correct link 
We're gonna have a bunch of these, aren't we?

[ci skip]
 2019-03-29 19:09:57 +01:00
Fabian Homborg
a361d987f8 docs: Add toctree back 
Apparently there must indeed be a toctree somewhere in the document to
get the links to the other docs to show up.

Even a ":hidden:" toctree doesn't help - that just leads to an empty
toc in the sidebar (no idea yet where that's defined!).

I've added it to the end so it's not that weird "Commands" section in
the middle.

[ci skip]
 2019-03-29 19:08:25 +01:00
Fabian Homborg
6cf61d5235 docs/fish_git_prompt: Fix formatting 
Sphinx likes empty lines before lists.

Also give variable names the ``treatment``.

[ci skip]
 2019-03-28 22:11:28 +01:00
Fabian Homborg
c94fe0f8c9 docs/fish_git_prompt: Document default settings 
This should help with interpreting the results.

All this is quite convoluted, especially with defaults dependent on
other settings.

[ci skip]
 2019-03-28 21:16:05 +01:00
Fabian Homborg
4e7795217d docs: Replace @cursor_key 
Should be the last of them.

See #5696.

[ci skip]
 2019-03-27 12:44:10 +01:00
Fabian Homborg
6a9079899d docs: Add an annotated completion example 
It's not _perfect_, but should hopefully ease the introduction a
teensy bit.

We use `timedatectl` because it's a reasonably simple command that
still uses subcommands and some generated candidates.

[ci skip]
 2019-03-27 12:40:38 +01:00
Fabian Homborg
b86200938f Always use "." for cd 
Nobody doesn't want to use $PWD to cd, so if $CDPATH does not include
it that was a mistake.

Bash also appends "." here.

Fixes #4484.
 2019-03-26 10:11:36 +01:00
Fabian Homborg
99d77c6049 docs: Replace &.arr; markup with unicode arrows 
This is still missing the @cursor_keys bit.

See #5696.

[ci skip]
 2019-03-24 20:03:52 +01:00
Fabian Homborg
848d538f08 docs: Replace @key markup with :kbd: 
The best I could find. It doesn't currently appear to render in the
html, but it's better than showing `@key{thing}`.
 2019-03-24 19:59:23 +01:00
Fabian Homborg
8837d17910 docs: Remove weird Commands subsection 
This included another copy of the TOC in the middle of the index page
and called it "Commands"?

See #5696.

cc @ridiculousfish

[ci skip]
 2019-03-24 19:51:27 +01:00
Fabian Homborg
295286b184 docs: Fix remaining "\subsection" markup 
See #5696.

[ci skip]
 2019-03-24 19:44:56 +01:00
GReagle
277a94c118 FAQ: how to check whether variable is defined or not empty (#5732) 
* FAQ: how to check whether variable is defined or not empty

* FAQ: how to check whether variable is not empty: include test in answer
 2019-03-21 10:24:08 +01:00
Fabian Homborg
f8b88d5b98 docs/fish_git_prompt: Better document variables 
More accurate, also the code example can now be copy-pasted.

[ci skip]
 2019-03-19 21:07:49 +01:00
Fabian Homborg
69abbd7b2a docs: Mention $__fish_x_dir in autoloading chapter 
That's what we want people to use instead of hardcoding
"/usr/share/fish", because that would break the code on other systems.

[ci skip]
 2019-03-18 21:10:18 +01:00
Fabian Homborg
9bd398b9fb Document features more 
This adds string-replace-fewer-backslashes, but also explains the
feature flag system a bit more.

[ci skip]
 2019-03-15 15:31:21 +01:00
Fabian Homborg
e7a964fdfa [count] Allow counting lines from stdin 
As a simple replacement for `wc -l`.

This counts both lines on stdin _and_ arguments.

So if "file" has three lines, then `count a b c < file` will print 6.

And since it counts newlines, like wc, `echo -n foo | count` prints 0.
 2019-03-15 14:31:36 +01:00
Fabian Homborg
4a67d9015b docs/command: Make it clearer that -a needs a commandname 
Fixes #5107.

[ci skip]
 2019-03-14 21:07:10 +01:00
hyperfekt
51cc03ca75 reflect #1912 in documentation 2019-03-13 10:10:38 +01:00
Fabian Homborg
6239c94fd4 docs/index: Fix <a href> links 
These don't work with sphinx, so we replace them with its style.

See #5696.

[ci skip]
 2019-02-25 21:52:44 +01:00
Fabian Homborg
9a1cd9c8ce docs/index: Fix links 
See #5696.

[ci skip]
 2019-02-25 21:29:39 +01:00
zabereer
2c8abdf5cb add $pipestatus support 2019-02-24 21:46:52 -08:00
Collin Styles
fa5d19a702 Fix broken link on index page 2019-02-24 20:22:56 -08:00
ridiculousfish
a1f122f603 Add license to sphinx docs build 2019-02-24 18:23:42 -08:00
ridiculousfish
2d75ab8e9b Add FAQ to sphinx docs build 2019-02-24 18:23:33 -08:00
ridiculousfish
db90f421c0 Add design doc to Sphinx docs build 2019-02-24 18:22:52 -08:00
ridiculousfish
6241bd8453 Add tutorial to sphinx docs build 2019-02-24 18:22:41 -08:00
ridiculousfish
6cd8856484 Add the vcs prompts to sphinx docs 2019-02-24 18:21:36 -08:00
ridiculousfish
9a35df059a Clean up fish_breakpoint_prompt sphinx docs 2019-02-24 18:15:48 -08:00
ridiculousfish
2b89cbc678 Incorporate sabine's index changes into sphinx docs 
Adds:
f6974e5a76
20c51b7da9
 2019-02-24 18:15:48 -08:00
ridiculousfish
d5e0392964 Incorporate most new doc changes since branch 
Adds most documentation changes since 72c0213d42
 2019-02-24 18:15:48 -08:00
ridiculousfish
3debfe7534 Break out commands into its own file 2019-02-24 18:15:48 -08:00
ridiculousfish
fb75d0f848 Parse out command descriptions from files for Sphinx man pages 
sphinx expects that the description for a command (as appearing in its man
page) be provided in conf.py, not in the rst file itself. LLVM handles this
with some custom Python code that parses it out of the file. Do the same
thing in fish.
 2019-02-24 18:15:48 -08:00
ridiculousfish
c8dc306b18 Fix command section separator line lengths 2019-02-24 18:15:48 -08:00
ridiculousfish
0e936198db Switch backticks to double backticks for rst compatibility 2019-02-24 18:15:48 -08:00
ridiculousfish
2a002a4ba1 Switch \fish sections to rst format 2019-02-24 18:15:48 -08:00
ridiculousfish
c33d1a217c Convert \\subsection sections into rst format 2019-02-24 18:15:48 -08:00
ridiculousfish
256c2dadee Migrate the 'synopsis' sections to .rst format 2019-02-24 18:15:48 -08:00
ridiculousfish
c213882511 Switch command docs from \section to reStructuredText 2019-02-24 18:15:48 -08:00
ridiculousfish
afd035f8cc Copy doc_src to sphinx_doc_src and add a TOC 2019-02-24 18:15:48 -08:00
ridiculousfish
cb045d5e6a Migrate index.rst to reStructuredText 2019-02-24 18:15:48 -08:00
ridiculousfish
c46f02e01e Initial sphinx file import 2019-02-24 18:15:23 -08:00