Skip to content

Commit 834ae08

Browse files
committed
Update docs
1 parent 82fc88e commit 834ae08

File tree

2 files changed

+20
-14
lines changed

2 files changed

+20
-14
lines changed

README.rst

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
11
tkfilebrowser
22
=============
33

4-
|Release|_ |Linux| |Travis| |Codecov| |License|
4+
|Release|_ |Linux| |Travis| |Codecov| |License| |Doc|
55

66
tkfilebrowser is an alternative to tkinter.filedialog that allows the
77
user to select files or directories. The GUI is written with tkinter but
88
the look is closer to GTK and the application uses GTK bookmarks (the
99
one displayed in nautilus or thunar for instance). This filebrowser
1010
supports new directory creation and filtype filtering.
1111

12-
This module contains a general `FileBrowser` class which implements the
12+
This module contains a general ``FileBrowser`` class which implements the
1313
filebrowser and the following functions, similar to the one in filedialog:
1414

15-
* `askopenfilename` that allow the selection of a single file
15+
* ``askopenfilename`` that allow the selection of a single file
1616

17-
* `askopenfilenames` that allow the selection of multiple files
17+
* ``askopenfilenames`` that allow the selection of multiple files
1818

19-
* `askopendirname` that allow the selection a single folder
19+
* ``askopendirname`` that allow the selection a single folder
2020

21-
* `askopendirnames` that allow the selection of multiple folders
21+
* ``askopendirnames`` that allow the selection of multiple folders
2222

23-
* `asksaveasfilename` that returns a single filename and give a warning if the file already exists
23+
* ``asksaveasfilename`` that returns a single filename and give a warning if the file already exists
2424

2525

2626
The documentation is also available here: https://tkfilebrowser.readthedocs.io
@@ -275,3 +275,6 @@ Example
275275
.. |License| image:: https://img.shields.io/github/license/j4321/tkFileBrowser.svg
276276
:target: https://www.gnu.org/licenses/gpl-3.0.en.html
277277
:alt: License
278+
.. |Doc| image:: https://readthedocs.org/projects/tkfilebrowser/badge/?version=latest
279+
:target: https://tkfilebrowser.readthedocs.io/en/latest/?badge=latest
280+
:alt: Documentation Status

docs/index.rst

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,26 @@
66
tkfilebrowser
77
=============
88

9-
|Release|_ |Linux| |Travis| |Codecov| |License|
9+
|Release|_ |Linux| |Travis| |Codecov| |License| |Doc|
1010

1111
tkfilebrowser is an alternative to tkinter.filedialog that allows the
1212
user to select files or directories. The GUI is written with tkinter but
1313
the look is closer to GTK and the application uses GTK bookmarks (the
1414
one displayed in nautilus or thunar for instance). This filebrowser
1515
supports new directory creation and filtype filtering.
1616

17-
This module contains a general `FileBrowser` class which implements the
17+
This module contains a general ``FileBrowser`` class which implements the
1818
filebrowser and the following functions, similar to the one in filedialog:
1919

20-
* `askopenfilename` that allow the selection of a single file
20+
* ``askopenfilename`` that allow the selection of a single file
2121

22-
* `askopenfilenames` that allow the selection of multiple files
22+
* ``askopenfilenames`` that allow the selection of multiple files
2323

24-
* `askopendirname` that allow the selection a single folder
24+
* ``askopendirname`` that allow the selection a single folder
2525

26-
* `askopendirnames` that allow the selection of multiple folders
26+
* ``askopendirnames`` that allow the selection of multiple folders
2727

28-
* `asksaveasfilename` that returns a single filename and give a warning if the file already exists
28+
* ``asksaveasfilename`` that returns a single filename and give a warning if the file already exists
2929

3030
Project page: https://github.com/j4321/tkFileBrowser
3131

@@ -54,3 +54,6 @@ Project page: https://github.com/j4321/tkFileBrowser
5454
.. |License| image:: https://img.shields.io/github/license/j4321/tkFileBrowser.svg
5555
:target: https://www.gnu.org/licenses/gpl-3.0.en.html
5656
:alt: License
57+
.. |Doc| image:: https://readthedocs.org/projects/tkfilebrowser/badge/?version=latest
58+
:target: https://tkfilebrowser.readthedocs.io/en/latest/?badge=latest
59+
:alt: Documentation Status

0 commit comments

Comments
 (0)