diff --git a/docs/glossary.rst b/docs/glossary.rst index f0179fbcf..9fc4e984a 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -32,7 +32,7 @@ Glossary top of an existing kitty window, entirely covering it. Overlays are used throught kitty, for example, to display the :ref:`the scrollback buffer `, to display :doc:`hints `, for :doc:`unicode input - ` etc. + ` etc. hyperlinks Terminals can have hyperlinks, just like the internet. In kitty you can diff --git a/docs/kittens/unicode-input.rst b/docs/kittens/unicode_input.rst similarity index 100% rename from docs/kittens/unicode-input.rst rename to docs/kittens/unicode_input.rst diff --git a/docs/kittens_intro.rst b/docs/kittens_intro.rst index 93847a333..c489da87e 100644 --- a/docs/kittens_intro.rst +++ b/docs/kittens_intro.rst @@ -7,15 +7,15 @@ Extend with kittens :hidden: :glob: + kittens/custom kittens/icat kittens/diff - kittens/unicode-input + kittens/unicode_input kittens/themes kittens/hints kittens/remote_file kittens/hyperlinked_grep kittens/transfer - kittens/custom kittens/* |kitty| has a framework for easily creating terminal programs that make use of @@ -32,7 +32,7 @@ Some prominent kittens: images -:doc:`Unicode Input ` +:doc:`Unicode Input ` Easily input arbitrary unicode characters in |kitty| by name or hex code. diff --git a/docs/overview.rst b/docs/overview.rst index a84808624..013162bc8 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -79,7 +79,7 @@ Extending kitty kitty has a powerful framework for scripting. You can create small terminal programs called :doc:`kittens `. These can used to add features to kitty, for example, :doc:`editing remote files ` or -:doc:`inputting unicode characters `. They can also be +:doc:`inputting unicode characters `. They can also be used to create programs that leverage kitty's powerful features, for example, :doc:`viewing images ` or :doc:`diffing files with images `. diff --git a/docs/support.rst b/docs/support.rst index b2588d3fa..373714812 100644 --- a/docs/support.rst +++ b/docs/support.rst @@ -7,7 +7,7 @@ end kitty has many foundational features, such as: :doc:`image support :doc:`various enhancements to the terminal protocol `, etc. These features allow the development of rich terminal applications, such as :doc:`Side-by-side diff ` and :doc:`Unicode input -`. +`. If you wish to support this mission and see the terminal ecosystem evolve, consider donating so that I can devote more time to |kitty| development. diff --git a/kitty/actions.py b/kitty/actions.py index ce447f4b8..ea306b5a3 100644 --- a/kitty/actions.py +++ b/kitty/actions.py @@ -86,7 +86,7 @@ def as_rst() -> str: def kitten_link(text: str) -> str: x = text.split() - return f':doc:`kittens/{x[2]}`'.replace('_', '-') if len(x) > 2 else '' + return f':doc:`kittens/{x[2]}`' if len(x) > 2 else '' for group in sorted(allg, key=key): title = group_title(group) diff --git a/kitty/boss.py b/kitty/boss.py index 9dbf041cb..9981996fb 100755 --- a/kitty/boss.py +++ b/kitty/boss.py @@ -1407,7 +1407,7 @@ class Boss: if data is not None: end_kitten(data, target_window_id, self) - @ac('misc', 'Input an arbitrary unicode character. See :doc:`/kittens/unicode-input` for details.') + @ac('misc', 'Input an arbitrary unicode character. See :doc:`/kittens/unicode_input` for details.') def input_unicode_character(self) -> None: self._run_kitten('unicode_input') diff --git a/publish.py b/publish.py index 73d34b5bb..2f187bdee 100755 --- a/publish.py +++ b/publish.py @@ -80,16 +80,9 @@ def run_html(args: Any) -> None: add_old_redirects('docs/_build/dirhtml') -def add_old_redirects(loc: str) -> None: - for dirpath, dirnames, filenames in os.walk(loc): - if dirpath != loc: - for fname in filenames: - if fname == 'index.html': - bname = os.path.basename(dirpath) - base = os.path.dirname(dirpath) - link_name = os.path.join(base, f'{bname}.html') if base else f'{bname}.html' - with open(link_name, 'w') as f: - f.write(f''' +def generate_redirect_html(link_name: str, bname: str) -> None: + with open(link_name, 'w') as f: + f.write(f''' Redirecting... @@ -108,6 +101,19 @@ window.location.replace('./{bname}/' + window.location.hash); ''') +def add_old_redirects(loc: str) -> None: + for dirpath, dirnames, filenames in os.walk(loc): + if dirpath != loc: + for fname in filenames: + if fname == 'index.html': + bname = os.path.basename(dirpath) + base = os.path.dirname(dirpath) + link_name = os.path.join(base, f'{bname}.html') if base else f'{bname}.html' + generate_redirect_html(link_name, bname) + + generate_redirect_html(os.path.join(loc, 'kittens', 'unicode-input.html'), 'unicode_input') + + def run_docs(args: Any) -> None: subprocess.check_call(['make', 'docs'])