Skip to content

Commit

Permalink
Merge pull request #879 from jazzband/fix-readthedocs
Browse files Browse the repository at this point in the history
Add a readthedocs configuration file
  • Loading branch information
rtpg committed Oct 26, 2023
2 parents 1b241a3 + e2cffd8 commit 9aaac8f
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 4 deletions.
13 changes: 13 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
version: 2
build:
os: ubuntu-22.04
tools:
python: "3.9"

python:
install:
- method: pip
path: .

sphinx:
configuration: docs/conf.py
1 change: 1 addition & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ These steps need to happen by a release maintainer.
To make a release, the following needs to happen:

- Make sure that ``setup.cfg`` is set up properly w/r/t Python and Django requirements
- Make sure the documentation (``docs/index.rst``) also describes the right Python/Django versions
- Bump the version number in ``taggit/__init__.py``
- Update the changelog (making sure to add the (Unreleased) section to the top)
- Get those changes onto the ``master`` branch
Expand Down
6 changes: 4 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import taggit

extensions = ["sphinx.ext.intersphinx"]

master_doc = "index"
Expand All @@ -6,9 +8,9 @@
copyright = "Alex Gaynor and individual contributors."

# The short X.Y version.
version = "1.3"
version = taggit.__version__
# The full version, including alpha/beta/rc tags.
release = "1.3.0"
release = taggit.__version__

intersphinx_mapping = {
"django": (
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Welcome to django-taggit's documentation!
``django-taggit`` is a reusable Django application designed to make adding
tagging to your project easy and fun.

``django-taggit`` works with Django 2.2+ and Python 3.6+.
``django-taggit`` works with Django 4.1+ and Python 3.8+.

.. toctree::
:maxdepth: 2
Expand Down
2 changes: 1 addition & 1 deletion taggit/__init__.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
VERSION = (5, 0, 0)
VERSION = (5, 0, 1)
__version__ = ".".join(str(i) for i in VERSION)

0 comments on commit 9aaac8f

Please sign in to comment.