Besmirch Search

.github/workflows/document.yml

@@ -16,19 +16,18 @@ jobs:
       fail-fast: true
       matrix:
         os: [ubuntu-latest]
-        python-version: ['3.13']
+        python-version: ['3.14']
 
     steps:
       - name: Clone Repository
-        uses: actions/checkout@v6
+        uses: actions/checkout@v7
       - name: Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v6
+        uses: actions/setup-python@v7
         with:
           python-version: ${{ matrix.python-version }}
       - name: Build
         run: |
           python -m pip install -e ../.[doc]
-          mkdir _static
           make clean
           make html
         working-directory: ./docs

.github/workflows/publish.yml

@@ -18,11 +18,11 @@ jobs:
 
     steps:
       - name: Clone Repository
-        uses: actions/checkout@v6
+        uses: actions/checkout@v7
         with:
           fetch-depth: 0
       - name: Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v6
+        uses: actions/setup-python@v7
         with:
           python-version: ${{ matrix.python-version }}
       - name: Dependencies

.github/workflows/test.yml

@@ -22,9 +22,9 @@ jobs:
 
     steps:
       - name: Clone Repository
-        uses: actions/checkout@v6
+        uses: actions/checkout@v7
       - name: Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v6
+        uses: actions/setup-python@v7
         with:
           python-version: ${{ matrix.python-version }}
       - name: Runner Environment

docs/conf.py

@@ -14,6 +14,7 @@
 
 import sys
 from os import environ, path
+from tomllib import load
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -31,6 +32,7 @@
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.coverage',
+    'sphinx_rtd_theme'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -53,10 +55,11 @@
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
-# The short X.Y version.
-version = '1.2.4'
 # The full version, including alpha/beta/rc tags.
-release = '1.2.4'
+with open('../pyproject.toml', 'rb') as pyproject:
+    release = load(pyproject)['project']['version']
+# The short X.Y version.
+version = release
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -109,11 +112,9 @@
 if not on_rtd:  # only import and set the theme if we're building docs locally
     import sphinx_rtd_theme
     html_theme = 'sphinx_rtd_theme'
-    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # otherwise, readthedocs uses their theme by default, so no need to specify it
 
-
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.

docs/index.rst

@@ -108,21 +108,23 @@ Example
                    exceptions=socket.timeout, preserve_mtime=True, tries=11)
 
 
-+-------------------+--------------------------+
-|                    API Diff                  |
-+-------------------+--------------------------+
-|      pysftp       |        sftpretty         |
-+===================+==========================+
-|        cwd        |          cd [#]_         |
-+-------------------+--------------------------+
-|     makedirs      |         mkdir_p          |
-+-------------------+--------------------------+
-|     walktree      |  {local,remote}tree [#]_ |
-+-------------------+--------------------------+
+.. table:: API Diff
+   :class: center-cells
+
+   +-------------------+--------------------------+
+   |      pysftp       |        sftpretty         |
+   +===================+==========================+
+   |        cwd        |          cd [#]_         |
+   +-------------------+--------------------------+
+   |     makedirs      |         mkdir_p          |
+   +-------------------+--------------------------+
+   |     walktree      |  {local,remote}tree [#]_ |
+   +-------------------+--------------------------+
 
 .. [#] cwd() is a synonym for chdir(), use cd it's shorter and does the same thing.
 .. [#] Connection.walktree & sftp.walktree with explicit naming.
-.. [*] [path_advance, path_retreat, reparent] no longer needed.
+.. note:: ``path_advance``, ``path_retreat`` and ``reparent`` are no longer
+   needed and have been removed.
 
 
 Additional Information

docs/sftpretty.rst

@@ -1,26 +1,37 @@
 API
 ===
-
+ 
 .. automodule:: sftpretty
+
+
+:class:`~sftpretty.CnOpts`
+--------------------------
+.. autoclass:: sftpretty.CnOpts
    :members:
-
-
-SecurityOptions
----------------
+
+
+:class:`~sftpretty.Connection`
+------------------------------
+.. autoclass:: sftpretty.Connection
+   :members:
+
+
+:class:`~paramiko.transport.SecurityOptions`
+--------------------------------------------
 A simple object returned with available security preferences.
-
+ 
 See `Security Options <https://docs.paramiko.org/en/latest/api/transport.html?highlight=ciphers#paramiko.transport.SecurityOptions>`_ for details.
-
-
-SFTPAttributes
---------------
+ 
+ 
+:class:`~paramiko.sftp_attr.SFTPAttributes`
+-------------------------------------------
 Representation of the attributes of a file or proxied file.
-
+ 
 See `SFTPAttributes <https://docs.paramiko.org/en/latest/api/sftp.html?highlight=sftpattributes#paramiko.sftp_attr.SFTPAttributes>`_ for details.
-
-
-SFTPFile
---------
+ 
+ 
+:class:`~paramiko.sftp_file.SFTPFile`
+-------------------------------------
 Proxy object for a file on the remote server.
-
+ 
 See `SFTPFile <https://docs.paramiko.org/en/latest/api/sftp.html?highlight=paramiko.sftp_file.sftpfile#paramiko.sftp_file.SFTPFile>`_ for details.