You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Use deferred links to improve readability.
- Fix broken documentation links.
- Explain `ViewStream` before `OutputPanel`.
- Replace mentions of a "syntax submodule" with "Syntax Utilities".
1. declare it as [dependency](https://packagecontrol.io/docs/dependencies):
10
+
1. declare it as [a dependency][pc-dependencies]:
11
11
12
12
Create a file named `dependencies.json`
13
13
with the following contents in package's root directory:
@@ -25,7 +25,7 @@ To make use of sublime_lib in a package...
25
25
Open _Command Palette_ and run `Package Control: Satisfy Libraries`
26
26
to ensure sublime_lib is installed and available for use.
27
27
28
-
2. Import sublime_lib in plugins, which want to make use of it.
28
+
2. Import sublime_lib in plugins which want to make use of it.
29
29
30
30
```python
31
31
import sublime_lib
@@ -34,28 +34,50 @@ To make use of sublime_lib in a package...
34
34
## Features
35
35
36
36
For complete documentation of all features,
37
-
see the [API documentation](https://sublimetext.github.io/sublime_lib/).
37
+
see the [API documentation][docs].
38
38
39
39
Highlights include:
40
40
41
-
-[`ActivityIndicator`](https://sublimetext.github.io/sublime_lib/#activity-indicator) context manager to indicate background activity via status bar.
42
-
-[`ResourcePath`](https://sublimetext.github.io/sublime_lib/#sublime_lib.ResourcePath), a [pathlib.Path](https://docs.python.org/3/library/pathlib.html) inspired representation of ST's resource paths,
a [pathlib.Path][]-inspired representation of ST's resource paths
43
45
with methods to convert from and to filesystem paths.
44
-
-[`SettingsDict`](https://sublimetext.github.io/sublime_lib/modules/sublime_lib.settings_dict.html) provides a standard Python `dict` inspired interface for `sublime.Settings` objects.
45
-
-[`OutputPanel`](https://sublimetext.github.io/sublime_lib/modules/sublime_lib.output_panel.html), extending `ViewStream` to provide additional functionality for output panel views.
46
-
-[`ViewStream`](https://sublimetext.github.io/sublime_lib/modules/sublime_lib.view_stream.html), a standard [Python IO stream](https://docs.python.org/3/library/io.html#io.TextIOBase) wrapping a `sublime.View` object
46
+
-[`SettingsDict`][sublime_lib.SettingsDict] provides a standard Python `dict`-like interface
47
+
for `sublime.Settings` objects.
48
+
-[`ViewStream`][sublime_lib.ViewStream],
49
+
providing a standard [Python IO stream][io.TextIOBase]
50
+
wrapping a `sublime.View` object.
51
+
-[`OutputPanel`][sublime_lib.OutputPanel],
52
+
extending `ViewStream` to provide additional functionality for output panel views.
47
53
48
54
### Deprecated
49
55
50
-
The [`flags` submodule](https://sublimetext.github.io/sublime_lib/#module-sublime_lib.flags) is deprecated in favour of native API, available as of ST4135.
56
+
The [`flags` submodule][sublime_lib.flags] is deprecated
57
+
in favour of native API,
58
+
available as of ST4135.
51
59
52
-
The [`syntax` submodule](https://sublimetext.github.io/sublime_lib/modules/sublime_lib.syntax.html), is marked deprecated in favour of native API functions, available as of ST4.
60
+
The [Syntax Utilities][] are marked deprecated
61
+
in favour of native API functions,
62
+
available as of ST4.
53
63
54
64
## Releasing a new version
55
65
56
66
1. Create a tag in the format `v<major>.<minor>.<patch>`
57
67
2. Push the tag to origin.
58
68
59
-
A GitHub action should be created that builds a WHEEL file,
0 commit comments