Skip to content

Commit

Permalink
Remove Tree Sitter mentions from docs
Browse files Browse the repository at this point in the history
Commit 4 in a series removing Tree Sitter Support from Salve in favor of Albero.
  • Loading branch information
Moosems committed Jul 25, 2024
1 parent 5e72cb5 commit 9950efa
Show file tree
Hide file tree
Showing 11 changed files with 2 additions and 317 deletions.
10 changes: 0 additions & 10 deletions docs/source/command-sheet.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,5 @@ Below is a chart outlining the different request commands you can give and the d
current_word: ``str`` (the word being searched for),

definition_starters: ``list[tuple[str, str]]`` (list of regexes to search for and a string associated (see :doc:`examples/simple_definitions_example`))
* - ``HIGHLIGHT_TREE_SITTER``
- file: ``str``,

language: ``str``,

text_range: ``tuple[int, int]`` (see HIGHLIGHT explanation),

tree_sitter_language: ``Callable | pathlib.Path | str`` (should be salve_dependency_hub.language() (see :ref:`Extra Tools <Salve Dependency Hub Overview>`) or a Path/str that points to a .so file) (this argument is optional after the first highlight if you've used that language before),

mapping: ``dict[str, str]`` (Tree Sitter token to desired ``Token`` type mapping)

To see how to use any given one of these in more detail, visit the :doc:`examples` page! Otherwise move on to the :doc:`special-classes` page instead.
2 changes: 1 addition & 1 deletion docs/source/example-usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,4 +100,4 @@ Some quick notes to remember as you use ``Salve``:

|br|

Of course, you can do far more with ``Salve`` than just getting syntac highlights. For example: what if you want to get autocompletions? Well, there is of course the the :doc:`command-sheet`.
Of course, you can do far more with ``Salve`` than just getting syntax highlights. For example: what if you want to get autocompletions? Well, there is of course the the :doc:`command-sheet`.
46 changes: 0 additions & 46 deletions docs/source/examples/logging_tree_sitter_example.rst

This file was deleted.

68 changes: 0 additions & 68 deletions docs/source/examples/mapping_logging_example.rst

This file was deleted.

64 changes: 0 additions & 64 deletions docs/source/examples/simple_mapping_example.rst

This file was deleted.

40 changes: 0 additions & 40 deletions docs/source/examples/simple_tree_sitter_highlights_example.rst

This file was deleted.

18 changes: 0 additions & 18 deletions docs/source/extra-tools.rst

This file was deleted.

9 changes: 1 addition & 8 deletions docs/source/functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,10 @@ Special Functions

This function lets you give a ``str`` as input (should only be one char long) and returns a ``bool`` value determining whether the unicode character was a letter or not (including ``"_"``).

.. _Unrefined Mapping Overview:

``make_unrefined_mapping()``
****************************

This function takes a Tree Sitter ``Tree``, the normal highlight output for the code the Tree is parsed from, a list of Tree Sitter token's to outright avoid, and optionally a logger.

.. |br| raw:: html

<br />

|br|

Next up is :doc:`extra-tools` and then to finish off the tour will be the :doc:`examples`!
Next up to finish off the tour will be the :doc:`examples`!
1 change: 0 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,4 @@ Welcome to ``Salve``'s Documentation! ``Salve`` is a library that can be used by
special-classes
variables
functions
extra-tools
examples
1 change: 0 additions & 1 deletion docs/source/variables.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ The ``COMMAND`` variable is a ``str`` type alias's used to prevent spelling mist
- ``HIGHLIGHT``
- ``EDITORCONFIG``
- ``DEFINITION``
- ``HIGHLIGHT_TREE_SITTER``

.. _Hidden Chars Overview:

Expand Down
60 changes: 0 additions & 60 deletions examples/mapping_logging_example.py

This file was deleted.

0 comments on commit 9950efa

Please sign in to comment.