Kovid Goyal
12bcee3b78
Fix #4258
2021-11-21 22:39:36 +05:30
Kovid Goyal
564f865a63
Fix the :italic: role used for CLI docs not being rendered correctly in the HTML docs
2021-11-19 14:28:05 +05:30
Kovid Goyal
6f19fd5912
Add more type annotations
2021-10-27 10:50:24 +05:30
Kovid Goyal
65e5015d19
Allow linking to discussions in docs
2021-07-31 11:51:03 +05:30
Kovid Goyal
1bd39ff935
Use new URL scheme and define the kitty website centrally as much as possible
2021-07-27 09:03:11 +05:30
Kovid Goyal
85e028cab1
Add links to kitten source code
2021-07-24 08:15:52 +05:30
Kovid Goyal
5027bc743b
Mark sidebar toc entry corresponding to current hash
...
Also scroll it to the top on initial page load
2021-07-21 14:41:01 +05:30
Kovid Goyal
54c04301cc
Use html_css_files instead of add_css_file
2021-07-21 13:12:32 +05:30
Kovid Goyal
cfd3bc823c
...
2021-07-21 12:36:55 +05:30
Kovid Goyal
329d95fd3a
Include all in page headings in the sidebar ToC
...
The furo theme tries to make this impossible, fortunately,
this being python, we dont care what it wants
2021-07-21 10:35:58 +05:30
Kovid Goyal
e6c17e19d7
Turn on nitpicky in makefile rather than conf.py
2021-07-20 13:57:58 +05:30
Kovid Goyal
624991b9b7
Use the builtin envvar role for env vars
...
Also fix some broken links
2021-07-20 13:29:39 +05:30
Kovid Goyal
f4ebec6759
The graphics protocol spec should link to POSIX not the linux man page
2021-07-20 09:51:15 +05:30
Kovid Goyal
fe18a5de92
Use a shorter title
2021-07-18 22:19:47 +05:30
Kovid Goyal
f787a377c3
A new theme for the kitty website
...
Supports dark mode. Also re-organize the documentation
a bit, making it more hierarchical.
Have a nicer landing page
2021-07-18 13:29:33 +05:30
Kovid Goyal
6e5ed38b76
Add syntax highlighting for mouse_map
2021-06-30 15:56:03 +05:30
Kovid Goyal
247d700c30
Fix docs build failure
2021-06-30 15:12:46 +05:30
Kovid Goyal
606708a96e
Cross reference builtin shortcuts from actions
2021-06-30 14:52:47 +05:30
Kovid Goyal
2ec0d94c31
Document all mappable actions
2021-06-30 14:33:28 +05:30
Kovid Goyal
0bbc4462fd
Coalesce shortcuts as well
2021-05-31 17:40:49 +05:30
Kovid Goyal
46b3f71b8f
Start work on porting docs generation
2021-05-31 17:40:49 +05:30
Kovid Goyal
ac2a01fb09
Implement documentation generation and conf file generation for mouse actions
2021-05-10 14:27:45 +05:30
Kovid Goyal
bdddb238f8
Also generate a man page for kitty.conf
2021-04-26 13:35:22 +05:30
Kovid Goyal
cd9755ffb3
Sphinx: replace use of deprecated css_files
2021-02-15 04:35:24 +05:30
Kovid Goyal
8ea589e5a3
Change blurb wording slightly
2021-01-12 20:01:44 +05:30
Kovid Goyal
3b8be26cc7
Workaround for Ubuntu as usual shipping with insanely outdated packages
...
Fixes #3160
2020-12-11 12:22:28 +05:30
Kovid Goyal
cd76d109f5
Fix a couple of documentation build warnings
2020-08-21 07:50:35 +05:30
Kovid Goyal
be3c76da20
Fix remote control command docs order randomized
2020-06-20 12:45:05 +05:30
Kovid Goyal
5e48ae8bac
pep8
2020-05-12 22:54:08 +05:30
Kovid Goyal
dfb543bd94
...
2020-03-14 15:27:38 +05:30
Kovid Goyal
c912eef040
Minor strictness increases
2020-03-14 14:59:31 +05:30
Kovid Goyal
b27f6d5957
more typing work
2020-03-12 14:26:51 +05:30
Kovid Goyal
149ae2866a
more typing work
2020-03-12 08:10:51 +05:30
Kovid Goyal
ac2c21e046
more typing work
2020-03-09 16:13:00 +05:30
Kovid Goyal
cc1336a616
More typing work
...
Also use a mypy based linter when editing
2020-03-08 11:02:14 +05:30
Kovid Goyal
9b32f18109
Refactor remote control commands into individual modules
...
Also add type information
2020-03-08 08:39:26 +05:30
Kovid Goyal
ad2bd1bf63
Allow using @selection in the launch cmdline
2019-11-13 10:46:04 +05:30
Kovid Goyal
d84da6b7b8
Documentation placeholder for the new launch interface
2019-11-13 10:09:43 +05:30
Luflosi
8b3b68ea69
Unify python encoding headers
...
All the other python encoding headers are of the form `vim:fileencoding=utf-8`.
2019-10-16 20:34:56 +02:00
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
