Update project structure and dependencies

Author: radiac

Diff for: .github/workflows/ci.yml

@@ -5,28 +5,33 @@ on:
   pull_request:
 
 jobs:
-  test-sqlite:
+  test:
     name: py-${{ matrix.python }}
     runs-on: ubuntu-latest
     strategy:
       matrix:
         include:
-          - python: "3.9"
+          - python: "3.11"
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python }}
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install -r requirements-dev.txt
+      - name: Set Python path
+        run: |
+            echo "PYTHONPATH=." >> $GITHUB_ENV
       - name: Test
         run: |
           pytest
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v1
+        uses: codecov/codecov-action@v4
         with:
           name: ${{ matrix.python }}
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

Diff for: .github/workflows/pypi.yml

@@ -10,20 +10,17 @@ jobs:
     name: Build and publish to PyPI
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python 3.9
-      uses: actions/setup-python@v2
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
       with:
-        python-version: 3.9
+        python-version: 3.11
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install setuptools wheel
+        pip install --upgrade setuptools build wheel
     - name: Build a binary wheel and a source tarball
       run: |
-        python setup.py sdist bdist_wheel
+        python -m build
     - name: Publish to PyPI
       if: startsWith(github.ref, 'refs/tags')
-      uses: pypa/gh-action-pypi-publish@master
-      with:
-        password: ${{ secrets.pypi_password }}
+      uses: pypa/gh-action-pypi-publish@release/v1

Diff for: .pre-commit-config.yaml

@@ -0,0 +1,19 @@
+exclude: .*migrations\/.*
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.4.0
+  hooks:
+  - id: check-merge-conflict
+  - id: trailing-whitespace
+- repo: https://github.com/pycqa/isort
+  rev: 5.12.0
+  hooks:
+  - id: isort
+    name: isort (python)
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.3.4
+  hooks:
+  # Run the linter.
+  - id: ruff
+  # Run the formatter.
+  - id: ruff-format

Diff for: LICENSE

@@ -1,7 +1,7 @@
 Sphinx-Gitref is licensed under the BSD License (BSD-3-Clause)
 ================================================================
 
-Copyright (c) 2020, Wildfish, https://wildfish.com
+Copyright (c) 2020, Richard Terry, https://radiac.net/
 
 All rights reserved.
 

Diff for: README.md

@@ -0,0 +1,148 @@
+# Sphinx Gitref
+
+
+[![PyPI](https://img.shields.io/pypi/v/sphinx-gitref.svg)](https://pypi.org/project/sphinx-gitref/)
+[![Tests](https://github.com/radiac/sphinx-gitref/actions/workflows/ci.yml/badge.svg)](https://github.com/radiac/sphinx-gitref/actions/workflows/ci.yml)
+[![Coverage](https://codecov.io/gh/radiac/sphinx-gitref/branch/main/graph/badge.svg?token=Q9AKPHRJF5)](https://codecov.io/gh/radiac/sphinx-gitref)
+
+Adds a `` :gitref:`..` `` role to sphinx to link to your code on GitHub, GitLab or
+Bitbucket, and to make sure the references in your docs match the code.
+
+Key features:
+
+* Check code references are up to date
+* Link to source code on github
+* Incorporate into tests or git hooks
+
+Supports Python 3.6+
+
+
+Installation
+============
+
+Install::
+
+    pip install sphinx-gitref
+
+
+Modify your Sphinx ``conf.py``:
+
+1. Add ``sphinx_gitref`` to the ``extensions`` list in your Sphinx ``conf.py``:
+
+
+   ```python
+   extensions = [
+       ...
+       'sphinx_gitref',
+   ]
+   ```
+
+2. Optional: Explicitly specify the remote URL.
+
+   Gitref will try to detect your remote origin URL from the ``.git`` dir in your docs'
+   parent dir. If it can't find it, or detects the wrong remote, you can set or override
+   the remote URL explicitly with::
+
+   ```python
+   gitref_remote_url = "https://github.com/username/repository.git"
+   ```
+
+3. Optional: Explicitly specify the branch to link to.
+
+   Gitref will try to detect your current branch from the ``.git`` dir in your docs'
+   parent dir. If it can't find it, or you'd like it to use a different branch, you can
+   set or override it explicitly with::
+
+   ```python
+   gitref_branch = "master"
+   ```
+
+4. Optional: Change the link label format when a coderef is provided without an
+   explicit label, eg `` :gitref:`filename.py::coderef` ``
+
+   Gitref defaults to using showing the coderef and dropping the filename. This can be
+   overridden by setting a format string::
+
+   ```python
+   gitref_label_format = "{filename} {coderef}"
+   ```
+
+## Usage
+
+The `` :gitref:`..` `` role supports the following features:
+
+* `` :gitref:`path/to/filename` ``
+* `` :gitref:`path/to/filename.py::coderef` ``
+
+You can optionally use them with a text label:
+
+* `` :gitref:`text <path/to/filename>` ``
+* `` :gitref:`text <path/to/filename.py::coderef>` ``
+
+where ``coderef`` is a Python class, function or variable. You can also refer to class
+attributes as you would in python, eg ``MyClass.attribute``.
+
+These will be replaced by a link to the code.
+
+If you do not provide a ``coderef``, gitref will just check that the file exists.
+
+Where you provide a ``coderef``, gitref will check that an object with that name exists
+in the code, and will add its line number to the link.
+
+
+### Examples
+
+Link to a file on gitref::
+
+```
+This file is :gitref:`README.rst`
+For more information, see the :gitref:`project README <README.rst>`
+```
+
+Link to a variable, function or class in a python file::
+
+```
+The method which turns a reference into a line number
+is :gitref:`sphinx_python/parse.py::python_to_lineno` -
+this will raise a warning if the reference is not found.
+
+Reference class attributes as you would in Python, such
+as :gitref:`sphinx_python/git.py::Repo.path`.
+```
+
+### Using in tests
+
+Because ``sphinx-gitref`` integrates into Sphinx, you can test the references are valid
+by performing a test build of your documentation.
+
+
+### Custom remotes
+
+If your code is stored somewhere other than one of the supported platforms, you can add
+a custom remote by subclassing ``sphinx_github.remotes.Remote`` in your Sphinx
+``conf.py``; for example::
+
+```python
+from sphinx_github.remotes import Remote
+class Gitea(Remote):
+    remote_match = re.compile(r"^git@gitea.example.com:(?P<repo>.+?)\.git$")
+    url_pattern = "https://gitea.example.com/{repo}/blob/{branch}/{filename}{line}"
+    url_pattern_line = "#L{line}"
+```
+
+
+## Changelog
+
+0.3.0 - 2024-05-19
+* Support latest Sphinx
+
+0.2.1 - 2022-02-19
+* Improve repository pattern matching
+
+0.2.0 - 2022-02-13
+* Add custom label formatting with ``gitref_label_format``
+* Fix bug when node target has no id
+* Improve branch detection to support a recently detached ``HEAD``
+
+0.1.0 - 2020-04-18
+* Initial release