Fabian Homborg
357a572b43
docs/index: Document repaint-mode
...
This was only mentioned in passing in the bind docs.
[ci skip]
2019-04-05 14:08:58 +02:00
Fabian Homborg
6c234a7385
docs: Remove a table
...
This was html, and I don't think it helped all that much, so let's
remove it instead of translating to rst.
[ci skip]
2019-03-31 11:56:12 +02:00
Fabian Homborg
ac61d3f34d
docs: More references
...
Including two more href.
2019-03-31 11:48:35 +02:00
Fabian Homborg
127c0e9764
docs: Fix remaining references
...
Fixes #5775 .
2019-03-31 11:35:02 +02:00
Fabian Homborg
bda3fb7740
docs: Fix a few wrong verbatim blocks
...
Wrong number of backticks.
[ci skip]
2019-03-31 11:25:07 +02:00
Fabian Homborg
203927245d
docs: Fix reference syntax
...
Fixes #5776 .
[ci skip]
2019-03-30 20:28:09 +01:00
Fabian Homborg
82d55aeb84
docs: Fix warnings
...
This was:
- Some `` mismatches - it's "``something``", not "``something`".
- Some "explicit targets", which IMHO are quite a misfeature - `word
<link>`_ has to be unique, which I don't see a usecase for. Instead
use `word <link>`__, with a double-underscore at the end.
- One case of `||` which I just removed
See #5696 .
[ci skip]
2019-03-29 21:07:36 +01:00
Fabian Homborg
191b74df6f
docs: Fix some sphinx errors
...
See #5696 .
[ci skip]
2019-03-29 20:55:28 +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
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
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
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
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
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
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