Skip to content

Commit

Permalink
Add release notes to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nvictus committed Aug 21, 2020
1 parent 7f80795 commit f23c21c
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 6 deletions.
4 changes: 4 additions & 0 deletions CHANGES
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
Release Notes
=============


1.1.0 (2020-08-21)
++++++++++++++++++

Expand Down
20 changes: 15 additions & 5 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
import sys
import os
import shlex
import re

# 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
Expand All @@ -38,7 +39,7 @@
'sphinx.ext.mathjax',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
'numpydoc',
"sphinx.ext.napoleon",
]

# Add any paths that contain templates here, relative to this directory.
Expand All @@ -63,11 +64,20 @@
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '1.0'
def _get_version():
init = os.path.join("..", "pqdict", "__init__.py")
with open(init) as fh:
text = fh.read()
version = re.search(
r'^__version__\s*=\s*[\'"]([^\'"]*)[\'"]', text, re.MULTILINE
).group(1)
return version

# The full version, including alpha/beta/rc tags.
release = '1.0.0'
release = _get_version()

# The short X.Y version.
version = release.rsplit(".", maxsplit=1)[0]

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
2 changes: 2 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ Release v\ |version|.

pqdict

release


* :ref:`genindex`

1 change: 1 addition & 0 deletions docs/release.rst
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Sphinx
sphinx-rtd-theme
numpydoc==0.5
numpydoc

0 comments on commit f23c21c

Please sign in to comment.