Version 1.2.0 release (#447)

* Version 1.2.0 release

* Remove six

* Fix docs requirements

* Fix sphinx

* Fix sphinx

.github/workflows/test.yml

@@ -17,9 +17,8 @@ jobs:
  - 'Django~=2.2.0'
  - 'Django~=3.2.0'
  - 'Django~=4.0.0'
+ - 'Django~=4.1.0'
  include:
- - python-version: '3.6'
- django-version: 'Django~=2.2.0'
  - python-version: '3.7'
  django-version: 'Django~=3.2.0'
 

.readthedocs.yml

@@ -0,0 +1,25 @@
+# .readthedocs.yml
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+ os: ubuntu-20.04
+ tools:
+ python: "3.9"
+ jobs:
+ pre_create_environment:
+ - asdf plugin add poetry
+ - asdf install poetry latest
+ - asdf global poetry latest
+ - poetry config virtualenvs.create false
+ post_install:
+ - |
+ . "$(pwd | rev | sed 's/stuokcehc/svne/' | rev)/bin/activate"
+ && poetry install --only main --only docs
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+ configuration: docs/conf.py
+ fail_on_warning: true
+
+formats: all

CHANGELOG.md

@@ -3,6 +3,15 @@
 We follow Semantic Version.
 
 
+## 1.2.0
+
+### Features
+
+- Adds `python3.10` support
+- Drops `python3.6` support
+- Adds `django4.1` support
+
+
 ## 1.1.0
 
 ### Features

README.md

@@ -28,9 +28,9 @@ Also, check this [example project](https://github.com/wemake-services/wemake-dja
 While this package will most likely work with the most versions of `django`, we [officially support](https://github.com/sobolevn/django-split-settings/blob/master/.github/workflows/test.yml):
 
 - 2.2
-- 3.1
 - 3.2
 - 4.0
+- 4.1
 
 This package has no dependencies itself.
 

docs/conf.py

@@ -15,18 +15,16 @@
 import os
 import sys
 
-import tomlkit
+import tomli
 
 sys.path.insert(0, os.path.abspath('..'))
 
 
 # -- Project information -----------------------------------------------------
 
 def _get_project_meta():
- with open('../pyproject.toml') as pyproject:
- file_contents = pyproject.read()
-
- return tomlkit.parse(file_contents)['tool']['poetry']
+ with open('../pyproject.toml', mode='rb') as pyproject:
+ return tomli.load(pyproject)['tool']['poetry']
 
 
 pkg_meta = _get_project_meta()
@@ -42,8 +40,7 @@ def _get_project_meta():
 
 # -- General configuration ---------------------------------------------------
 
-# If your documentation needs a minimal Sphinx version, state it here.
-needs_sphinx = '3.2'
+needs_sphinx = '3.3'
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -55,8 +52,6 @@ def _get_project_meta():
  'sphinx.ext.coverage',
  'sphinx.ext.viewcode',
  'sphinx.ext.autosummary',
-
- # Used to write beautiful docstrings:
  'sphinx.ext.napoleon',
 
  # Used to include .md files:
@@ -69,6 +64,9 @@ def _get_project_meta():
 autoclass_content = 'class'
 autodoc_member_order = 'bysource'
 
+autodoc_member_order = 'bysource'
+autodoc_default_flags = {}
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
@@ -85,7 +83,7 @@ def _get_project_meta():
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -97,17 +95,25 @@ def _get_project_meta():
 
 add_module_names = False
 
-# Set `typing.TYPE_CHECKING` to `True`:
-# https://pypi.org/project/sphinx-autodoc-typehints/
-set_type_checking_flag = False
+autodoc_default_options = {
+ 'show-inheritance': True,
+}
 
 
-# -- Options for HTML output ----------------------------------------------
+# -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages. See the documentation for
 # a list of builtin themes.
 html_theme = 'alabaster'
 
+# 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.
+html_theme_options = {
+ 'sidebar_collapse': False,
+ 'show_powered_by': False,
+}
+
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
@@ -122,9 +128,18 @@ def _get_project_meta():
  '**': [
  'about.html',
  'navigation.html',
- 'badges.html',
  'moreinfo.html',
  'github.html',
  'searchbox.html',
  ],
 }
+
+
+# -- Extension configuration -------------------------------------------------
+
+napoleon_numpy_docstring = False
+
+# -- Options for todo extension ----------------------------------------------
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True