Improve docs formatting

Author: j4321

docs/changelog.rst

@@ -28,7 +28,7 @@ tkfilebrowser 2.2.4
 tkfilebrowser 2.2.3
 -------------------
 
-* Fix FileNotFoundError if initialdir does not exist
+* Fix :obj:`FileNotFoundError` if initialdir does not exist
 * Add Desktop in shortcuts (if found)
 * Improve filetype filtering
 
@@ -60,7 +60,7 @@ tkfilebrowser 2.1.1
 tkfilebrowser 2.1.0
 -------------------
 
-* Add compatibility with tkinter.filedialog keywords 'master' and 'defaultextension'
+* Add compatibility with :mod:`tkinter.filedialog` keywords 'master' and 'defaultextension'
 * Change look of filetype selector
 * Fix bugs when navigating without displaying hidden files
 * Fix color alternance bug when hiding hidden files

docs/index.rst

@@ -14,23 +14,23 @@ the look is closer to GTK and the application uses GTK bookmarks (the
 one displayed in nautilus or thunar for instance). This filebrowser
 supports new directory creation and filtype filtering.
 
-This module contains a general ``FileBrowser`` class which implements the
+This module contains a general :class:`~tkfilebrowser.FileBrowser` class which implements the
 filebrowser and the following functions, similar to the one in filedialog:
 
-    * ``askopenfilename`` that allow the selection of a single file
+    * :func:`~tkfilebrowser.askopenfilename` that allow the selection of a single file
 
-    * ``askopenfilenames`` that allow the selection of multiple files
+    * :func:`~tkfilebrowser.askopenfilenames` that allow the selection of multiple files
 
-    * ``askopendirname`` that allow the selection a single folder
+    * :func:`~tkfilebrowser.askopendirname` that allow the selection a single folder
 
-    * ``askopendirnames`` that allow the selection of multiple folders
+    * :func:`~tkfilebrowser.askopendirnames` that allow the selection of multiple folders
 
-    * ``asksaveasfilename`` that returns a single filename and give a warning if the file already exists
+    * :func:`~tkfilebrowser.asksaveasfilename` that returns a single filename and give a warning if the file already exists
 
 Project page: https://github.com/j4321/tkFileBrowser
 
 .. toctree::
-   :maxdepth: 4
+   :maxdepth: 1
    :caption: Contents:
 
    installation

tkfilebrowser/filebrowser.py

@@ -93,11 +93,11 @@ def __init__(self, parent, initialdir="", initialfile="", mode="openfile",
         defaultext : str (e.g. '.png')
             extension added to filename if none is given (default is none)
 
-        filetypes : list ``[("name", "*.ext1|*.ext2|.."), ...]``
+        filetypes : list :obj:`[("name", "*.ext1|*.ext2|.."), ...]`
           only the files of given filetype will be displayed,
           e.g. to allow the user to switch between displaying only PNG or JPG
           pictures or dispalying all files:
-          ``filtypes=[("Pictures", "\*.png|\*.PNG|\*.jpg|\*.JPG'), ("All files", "\*")]``
+          :obj:`filtypes=[("Pictures", "\*.png|\*.PNG|\*.jpg|\*.JPG'), ("All files", "\*")]`
 
         okbuttontext : str
             text displayed on the validate button, default is "Open".

tkfilebrowser/functions.py

@@ -27,7 +27,7 @@
 
 def askopendirname(parent=None, title=_("Open"), **kwargs):
     """
-    Return ``''`` or the absolute path of the chosen directory.
+    Return :obj:`''` or the absolute path of the chosen directory.
 
     Arguments:
     
@@ -43,11 +43,11 @@ def askopendirname(parent=None, title=_("Open"), **kwargs):
         initialfile : str
             initially selected item (just the name, not the full path)
 
-        filetypes : list ``[("name", "*.ext1|*.ext2|.."), ...]``
+        filetypes : list :obj:`[("name", "*.ext1|*.ext2|.."), ...]`
           only the files of given filetype will be displayed,
           e.g. to allow the user to switch between displaying only PNG or JPG
           pictures or dispalying all files:
-          filtypes=[("Pictures", "\*.png|\*.PNG|\*.jpg|\*.JPG'), ("All files", "\*")]
+          :obj:`filtypes=[("Pictures", "\*.png|\*.PNG|\*.jpg|\*.JPG'), ("All files", "\*")]`
 
         okbuttontext : str
             text displayed on the validate button, default is "Open".
@@ -66,7 +66,7 @@ def askopendirname(parent=None, title=_("Open"), **kwargs):
 
 def askopendirnames(parent=None, title=_("Open"), **kwargs):
     """
-    Return ``()`` or the tuple of the absolute paths of the chosen directories
+    Return :obj:`()` or the tuple of the absolute paths of the chosen directories
 
     Arguments:
     
@@ -82,11 +82,11 @@ def askopendirnames(parent=None, title=_("Open"), **kwargs):
         initialfile : str
             initially selected item (just the name, not the full path)
 
-        filetypes : list ``[("name", "*.ext1|*.ext2|.."), ...]``
+        filetypes : list :obj:`[("name", "*.ext1|*.ext2|.."), ...]`
           only the files of given filetype will be displayed,
           e.g. to allow the user to switch between displaying only PNG or JPG
           pictures or dispalying all files:
-          ``filtypes=[("Pictures", "\*.png|\*.PNG|\*.jpg|\*.JPG'), ("All files", "\*")]``
+          :obj:`filtypes=[("Pictures", "\*.png|\*.PNG|\*.jpg|\*.JPG'), ("All files", "\*")]`
 
         okbuttontext : str
             text displayed on the validate button, default is "Open".
@@ -108,7 +108,7 @@ def askopendirnames(parent=None, title=_("Open"), **kwargs):
 
 def askopenfilename(parent=None, title=_("Open"), **kwargs):
     """
-    Return ``''`` or the absolute path of the chosen file
+    Return :obj:`''` or the absolute path of the chosen file
 
     Arguments:
     
@@ -124,11 +124,11 @@ def askopenfilename(parent=None, title=_("Open"), **kwargs):
         initialfile : str
             initially selected item (just the name, not the full path)
 
-        filetypes : list ``[("name", "*.ext1|*.ext2|.."), ...]``
+        filetypes : list :obj:`[("name", "*.ext1|*.ext2|.."), ...]`
           only the files of given filetype will be displayed,
           e.g. to allow the user to switch between displaying only PNG or JPG
           pictures or dispalying all files:
-          ``filtypes=[("Pictures", "\*.png|\*.PNG|\*.jpg|\*.JPG'), ("All files", "\*")]``
+          :obj:`filtypes=[("Pictures", "\*.png|\*.PNG|\*.jpg|\*.JPG'), ("All files", "\*")]`
 
         okbuttontext : str
             text displayed on the validate button, default is "Open".
@@ -147,7 +147,7 @@ def askopenfilename(parent=None, title=_("Open"), **kwargs):
 
 def askopenfilenames(parent=None, title=_("Open"), **kwargs):
     """
-    Return ``()`` or the tuple of the absolute paths of the chosen files
+    Return :obj:`()` or the tuple of the absolute paths of the chosen files
 
     Arguments:
     
@@ -163,11 +163,11 @@ def askopenfilenames(parent=None, title=_("Open"), **kwargs):
         initialfile : str
             initially selected item (just the name, not the full path)
 
-        filetypes : list ``[("name", "*.ext1|*.ext2|.."), ...]``
+        filetypes : list :obj:`[("name", "*.ext1|*.ext2|.."), ...]`
           only the files of given filetype will be displayed,
           e.g. to allow the user to switch between displaying only PNG or JPG
           pictures or dispalying all files:
-          ``filtypes=[("Pictures", "\*.png|\*.PNG|\*.jpg|\*.JPG'), ("All files", "\*")]``
+          :obj:`filtypes=[("Pictures", "\*.png|\*.PNG|\*.jpg|\*.JPG'), ("All files", "\*")]`
 
         okbuttontext : str
             text displayed on the validate button, default is "Open".
@@ -189,7 +189,7 @@ def askopenfilenames(parent=None, title=_("Open"), **kwargs):
 
 def asksaveasfilename(parent=None, title=_("Save As"), **kwargs):
     """
-    Return ``''`` or the chosen absolute path (the file might not exist)
+    Return :obj:`''` or the chosen absolute path (the file might not exist)
     
     Arguments:
     
@@ -208,11 +208,11 @@ def asksaveasfilename(parent=None, title=_("Save As"), **kwargs):
         defaultext : str (e.g. '.png')
             extension added to filename if none is given (default is none)  
 
-        filetypes : list ``[("name", "*.ext1|*.ext2|.."), ...]``
+        filetypes : list :obj:`[("name", "*.ext1|*.ext2|.."), ...]`
           only the files of given filetype will be displayed,
           e.g. to allow the user to switch between displaying only PNG or JPG
           pictures or dispalying all files:
-          ``filtypes=[("Pictures", "\*.png|\*.PNG|\*.jpg|\*.JPG'), ("All files", "\*")]``
+          :obj:`filtypes=[("Pictures", "\*.png|\*.PNG|\*.jpg|\*.JPG'), ("All files", "\*")]`
 
         okbuttontext : str
             text displayed on the validate button, default is "Open".