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
Copy file name to clipboardExpand all lines: README.md
+6-16Lines changed: 6 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,22 +7,12 @@ The main goal of this project is to help developer provide better documentation
7
7
8
8
Installation
9
9
------------
10
-
**Manually**
11
-
Until this project can get onto Package Control, the only way to install it is manually.
12
-
You can add this repo to package control manually and install it that way
13
-
14
-
1. Open your command pallete and type `Package Control: Add Repository`
15
-
1. Copy and paste the [github url](https://github.com/adambullmer/sublime_docblockr_python) into the input field at the bottom of Sublime Text and press `Enter`
16
-
1. Ensure the status bar says it was successfully added.
17
-
18
-
19
-
Now you can install it with package control.
20
-
10
+
**Package Control**
11
+
Now you can install it with package control!
21
12
1. Open your command pallete and type `Package Control: Install Package`.
22
-
1. Find this project `sublime_docblockr_python` and press `Enter`.
23
-
13
+
1. Find this project `DocBlockr Python` and press `Enter`.
24
14
25
-
**Slightly More Manually**
15
+
**Manually**
26
16
Download the release and put it in your installed packages directory yourself
27
17
28
18
1. Go to the [Latest Release](https://github.com/adambullmer/sublime-docblockr-python/releases/latest) and download the `docblockr_python.sublime-package` file.
@@ -48,7 +38,7 @@ You can also override your user settings on a per project basis by editing your
48
38
"formatter": "sphinx"
49
39
},
50
40
"folders": [
51
-
//...
41
+
// ...
52
42
]
53
43
}
54
44
```
@@ -69,7 +59,7 @@ If you don't like the formatting styles above, or want to make your own style to
69
59
All you will need to do is extend the [Base formatter](https://github.com/adambullmer/sublime-docblockr-python/blob/master/formatters/base.py#L32) class and write your formatter functions.
70
60
If you're not sure about it, you can take a look at any of the other formatters in the `formatters` source dir and see how they did it.
71
61
```py
72
-
fromsublime_docblockr_python.formatters.base import Base
0 commit comments