Kovid Goyal
3a5baf2722
Merge branch 'doc/mapping_shortcuts' of https://github.com/MagicDuck/kitty
2019-07-29 09:13:16 +05:30
Kovid Goyal
658be9405f
Document the kitty remote control protocol
...
Fixes #1646
2019-06-12 13:12:53 +05:30
Luflosi
951b1c1e83
Add shebang for docs/conf.py
2019-05-28 17:17:18 +02:00
Luflosi
6f2bb31068
Make the copyright year dynamic for the documentation
2019-05-28 14:58:09 +02:00
Kovid Goyal
d5846282a9
Avoid bikeshedding about the best way to suppress flake8 messages
2019-04-24 23:46:24 +05:30
Kovid Goyal
099510f4d1
Fix docs build failure
...
dynamic_background_opacity needs to be its own option in the conf docs.
2019-04-24 15:39:16 +05:30
Kovid Goyal
da999f730b
Dont assume sphinx-build is a python script
...
Fixes #1561
2019-04-24 15:12:36 +05:30
Luflosi
d8eeed2296
Convert HTTP URLs to HTTPS URLs where possible
2019-04-24 01:27:24 +02:00
Kovid Goyal
c7a3a4d421
Fix use of deprecated sphinx API
2019-01-19 14:16:38 +05:30
Kovid Goyal
3b1490020d
...
2018-06-26 12:35:38 +05:30
Daniel Hahler
8a0cd73821
docs: improve generation of default config files
...
- config files are placed into `docs/generated/conf/`, using the
expected name, and without any indentation
- `literalinclude::` is used instead of `include::`
- uses `:download:` instead of `:file:` to allow for downloading the
generated files easily
2018-06-16 18:35:58 +02:00
Kovid Goyal
a7d533cfe5
Increase contrast of link color with text color in docs
2018-06-15 15:38:30 +05:30
Kovid Goyal
52ec4dc21b
Allow cross-linking to @ command documentation
2018-06-15 15:31:05 +05:30
Kovid Goyal
f88b98ccd9
Generate a simple man page with the output of kitty --help
2018-06-08 10:13:15 +05:30
Kovid Goyal
7b1449ba46
Include sample conf files
2018-06-05 13:57:51 +05:30
Kovid Goyal
c509c5eb0d
Add custom syntax highlighting for conf and session files
2018-06-05 12:37:04 +05:30
Kovid Goyal
d39cf5d702
Get rid of the default diff.conf
2018-06-05 10:44:18 +05:30
Kovid Goyal
ea4a7136f0
Get rid of the |kitty.conf| substitution
2018-06-05 08:44:51 +05:30
Kovid Goyal
065a2b37c7
Get rid of the |sc_| substitution rules
2018-06-05 08:13:28 +05:30
Kovid Goyal
4fa8cb562a
Finish adding shortcuts to docs
2018-06-05 07:52:31 +05:30
Kovid Goyal
4c636fdeca
More conf docs
2018-06-05 07:52:31 +05:30
Kovid Goyal
1168687923
More conf docs
2018-06-05 07:52:30 +05:30
Kovid Goyal
e7246fd024
Implement shortcuts in the RST docs
2018-06-05 07:52:30 +05:30
Kovid Goyal
cd36e3b314
oops
2018-06-05 07:52:30 +05:30
Kovid Goyal
b98fca972f
More conf docs
...
Add a 🔗 role that works nicely in both contexts
2018-06-05 07:52:29 +05:30
Kovid Goyal
6c1434ab8a
More conf docs
...
Also dont parse option values unnecessarily
2018-06-05 07:52:29 +05:30
Kovid Goyal
b6d33e2019
More conf docs
2018-06-05 07:52:29 +05:30
Kovid Goyal
485fe0a7fb
Allow linking to latter options in a option group
2018-06-05 07:52:29 +05:30
Kovid Goyal
f7fe59dfbe
Allow multiple conf files to be processed for cross-references
2018-06-05 07:52:28 +05:30
Kovid Goyal
fd731feacc
Warn about missing opt references
2018-06-05 07:52:28 +05:30
Kovid Goyal
61194ef1c8
Use a custom sphinx role for the conf file
2018-06-05 07:52:28 +05:30
Kovid Goyal
ffdb91ffd5
More work on the conf docs
2018-06-05 07:52:28 +05:30
Kovid Goyal
2ae3157d49
Simplify by using the option definition as a title
2018-06-05 07:52:28 +05:30
Kovid Goyal
8c7e618324
Implement referring to config options
2018-06-05 07:52:27 +05:30
Kovid Goyal
9dc9fb2012
Start work on documenting the conf file
2018-06-05 07:52:27 +05:30
Kovid Goyal
8d04216c2b
Update CHANGELOG
2018-06-02 15:04:45 +05:30
Kovid Goyal
9a615efa83
Document CLI of panel kitten
2018-06-02 12:24:21 +05:30
Kovid Goyal
8d8224812d
Use modern GA loading code
2018-05-30 20:28:48 +05:30
Kovid Goyal
fb0db2b7df
Document kitty @
2018-05-30 19:35:54 +05:30
Kovid Goyal
28803d9a5a
Use rst roles to format cli help text
2018-05-30 19:07:12 +05:30
Kovid Goyal
f8fa76d77e
Use program directives to namespace options
2018-05-30 15:32:50 +05:30
Kovid Goyal
a3e4c74f5d
Add command line API reference
2018-05-30 15:14:07 +05:30
Kovid Goyal
0667027506
...
2018-05-30 13:45:27 +05:30
Kovid Goyal
0c5c6fcbbe
Make the sidebar a little nicer
2018-05-30 13:43:48 +05:30
Kovid Goyal
611d95f0f7
Add the CHANGELOG to the docs
2018-05-30 12:46:00 +05:30
Kovid Goyal
bbc1430420
Add a support page
...
Also fix a few links flagged by make linkcheck
2018-05-30 12:08:20 +05:30
Kovid Goyal
21d7cc1a60
Configure the alabaster theme a bit
...
And remove duplicated FAQ from README
2018-05-30 09:44:53 +05:30
Kovid Goyal
f82b7841c6
Start work on a kitty website
...
Port the current asciidoc documentation to sphinx
2018-05-29 21:03:50 +05:30
