Backport changes

.github/SECURITY.md

@@ -5,9 +5,9 @@
 | Version | Python |        Supported         |
 | :-----: | :----: | :----------------------: |
 |   1.4   |  3.8+  |    :heavy_check_mark:    |
-|   1.3   |  3.7+  |    :heavy_check_mark:    |
-|   1.2   |  3.6+  |    :heavy_check_mark:    |
-|   1.1   |  3.5+  |    :heavy_check_mark:    |
+|   1.3   |  3.7+  | :heavy_multiplication_x: |
+|   1.2   |  3.6+  | :heavy_multiplication_x: |
+|   1.1   |  3.5+  | :heavy_multiplication_x: |
 |   1.0   |  3.5+  | :heavy_multiplication_x: |
 | <1.0 |  2.7+  | :heavy_multiplication_x: |
 
@@ -16,7 +16,7 @@
 * Do not create issues to report security vulnerabilities.
 * Instead, please e-mail the maintainer at [chronobserver@disroot.org](mailto:chronobserver@disroot.org).
 * Do not include any confidential information in the e-mail.
-* Provide your GitHub username (if available), so that we can invite
-  you to collaborate on a [security advisory][advisories] on GitHub.
+* Provide your GitHub username (if available), so that you can be
+  invited to collaborate on a [security advisory][advisories] on GitHub.
 
 [advisories]: https://help.github.com/en/github/managing-security-vulnerabilities/about-github-security-advisories

.github/workflows/deploy.yml

@@ -13,9 +13,9 @@ jobs:
       with:
         python-version: '3.8'
     - name: Install Poetry
-      uses: abatilo/actions-poetry@v2.2.0
+      uses: abatilo/actions-poetry@v2.3.0
       with:
-        poetry-version: 1.3.1
+        poetry-version: 1.6.1
     - name: Deploy to PyPI
       run: poetry publish --build
       env:

.github/workflows/tests.yml

@@ -23,16 +23,15 @@ jobs:
         with:
           python-version: ${{matrix.python}}
       - name: Install Poetry
-        uses: abatilo/actions-poetry@v2.2.0
+        uses: abatilo/actions-poetry@v2.3.0
         with:
-          poetry-version: 1.3.1
+          poetry-version: 1.6.1
       - name: Install dependencies
         run: poetry install
       - name: Lint project
         run: >-
-          poetry run pylint yaenv &&
-          poetry run mypy -p yaenv &&
-          poetry run pydocstyle yaenv
+          poetry run ruff yaenv &&
+          poetry run mypy -p yaenv
       - name: Run tests
         run: poetry run pytest --cov-report=xml
       - name: Upload coverage to codecov

.gitignore

@@ -173,6 +173,9 @@ venv.bak/
 .dmypy.json
 dmypy.json
 
+# ruff
+.ruff_cache/
+
 # Pyre type checker
 .pyre/
 
@@ -195,4 +198,4 @@ tags
 [._]*.un~
 
 # Configuration
-.lvimrc
+.nvimrc

.readthedocs.yml

@@ -1,9 +1,15 @@
 version: 2
-python:
-    version: '3.8'
-    install:
-        - requirements: docs/requirements.txt
-    system_packages: false
+build:
+    os: ubuntu-22.04
+    tools:
+      python: '3.8'
+    jobs:
+      post_create_environment:
+        - pip install poetry
+        - poetry config virtualenvs.create false
+      post_install:
+        - poetry install --with docs
 sphinx:
     builder: html
     configuration: docs/conf.py
+    fail_on_warning: true

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2019-2022 ObserverOfTime
+Copyright (c) 2019-2023 ObserverOfTime
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

README.rst

@@ -3,12 +3,12 @@ yaenv
 
 |pypi| |rtd| |github| |codecov|
 
-.. |pypi| image:: https://img.shields.io/pypi/v/yaenv/1.4.3.post2.svg?logo=python
-   :target: https://pypi.org/project/yaenv/1.4.3.post2/
+.. |pypi| image:: https://img.shields.io/pypi/v/yaenv/1.4.4.svg?logo=python
+   :target: https://pypi.org/project/yaenv/1.4.4/
    :alt: PyPI
 
-.. |rtd| image:: https://img.shields.io/readthedocs/yaenv/v1.4.3.post2.svg?logo=read-the-docs
-   :target: https://yaenv.readthedocs.io/en/v1.4.3.post2/
+.. |rtd| image:: https://img.shields.io/readthedocs/yaenv/v1.4.4.svg?logo=read-the-docs
+   :target: https://yaenv.readthedocs.io/en/v1.4.4/
    :alt: Read the Docs
 
 .. |github| image:: https://img.shields.io/github/actions/workflow/status/ObserverOfTime/yaenv/tests.yml?label=build&logo=github&branch=py3.8

docs/conf.py

@@ -16,15 +16,14 @@
 import os
 import re
 import sys
-import sphinx_rtd_theme
 
 sys.path.insert(0, os.path.abspath('..'))
 sys.path.append(os.path.dirname(__file__))
 
 # -- Project information -----------------------------------------------------
 
 project = 'yaenv'
-copyright = '2019-2022, ObserverOfTime, BSD 3-Clause License'
+copyright = '2019-2023, ObserverOfTime, BSD 3-Clause License'
 author = 'ObserverOfTime'
 
 # The full version, including alpha/beta/rc tags
@@ -39,6 +38,7 @@
     'sphinx.ext.extlinks',
     'sphinx.ext.napoleon',
     'sphinx.ext.viewcode',
+    'sphinxcontrib.jquery',
 ]
 
 # Napoleon settings
@@ -48,10 +48,11 @@
 napoleon_include_private_with_doc = False
 napoleon_include_special_with_doc = True
 napoleon_use_admonition_for_examples = False
-napoleon_use_admonition_for_notes = False
-napoleon_use_admonition_for_references = False
+napoleon_use_admonition_for_notes = True
+napoleon_use_admonition_for_references = True
+napoleon_attr_annotations = True
 napoleon_use_ivar = True
-napoleon_use_param = True
+napoleon_use_param = False
 napoleon_use_rtype = False
 
 # Autodoc settings
@@ -71,10 +72,10 @@
 
 master_doc = 'index'
 
-needs_sphinx = '5.1'
+needs_sphinx = '6.2'
 
 extlinks = {
-    'dj': ('https://docs.djangoproject.com/en/4.1/ref/settings/#%s', '%s'),
+    'dj': ('https://docs.djangoproject.com/en/4.2/ref/settings/#%s', '%s'),
     'os': ('https://docs.python.org/3.8/library/os.html#os.%s', 'os.%s')
 }
 
@@ -83,7 +84,9 @@
 # The theme to use for HTML and HTML Help pages.
 # See the documentation for a list of builtin themes.
 html_theme = 'sphinx_rtd_theme'
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+html_theme_path = [
+    __import__(html_theme).get_html_theme_path()
+]
 html_theme_options = {
     'display_version': True,
     'collapse_navigation': True,

docs/modules.rst

@@ -4,7 +4,7 @@ API reference
 .. default-domain:: py
 
 core module
--------------
+-----------
 
 .. automodule:: yaenv.core
    :members: