Skip to content

Commit

Permalink
REL: Administrative updates for release
Browse files Browse the repository at this point in the history
  • Loading branch information
bskinn committed Feb 1, 2019
1 parent a4ac7d0 commit dc46fe3
Show file tree
Hide file tree
Showing 21 changed files with 46 additions and 26 deletions.
14 changes: 13 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,24 @@
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
and this project strives to adhere to
[Semantic Versioning](http://semver.org/spec/v2.0.0.html).


### Unreleased Changes

...


### [2.0.1rc1] - 2019-02-01

#### Fixed

* Sphinx *can* generate inventories with empty-string values for
`project` and `version`; `sphobjinv` now can import such
inventories without error.


### [2.0.0] - 2018-08-16

#### Added
Expand Down
2 changes: 1 addition & 1 deletion LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2016-2018 Brian Skinn
Copyright (c) 2016-2019 Brian Skinn

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
5 changes: 4 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ sphobjinv: Manipulate and inspect Sphinx objects.inv files
.. image:: https://img.shields.io/github/license/mashape/apistatus.svg
:target: https://github.com/bskinn/sphobjinv/blob/master/LICENSE.txt

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/ambv/black

----

**Using Sphinx?**
Expand Down Expand Up @@ -134,7 +137,7 @@ Source on `GitHub <https://github.com/bskinn/sphobjinv>`__. Bug reports
and feature requests are welcomed at the
`Issues <https://github.com/bskinn/sphobjinv/issues>`__ page there.

Copyright (c) Brian Skinn 2016-2018
Copyright (c) Brian Skinn 2016-2019

License: The MIT License. See `LICENSE.txt <https://github.com/bskinn/sphobjinv/blob/master/LICENSE.txt>`__
for full license terms.
4 changes: 2 additions & 2 deletions doc/source/cli/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,9 @@ The options for the parent |soi| command are:

>>> cli_run('sphobjinv --version')
<BLANKLINE>
sphobjinv v2.0
sphobjinv v2.0.1rc1
<BLANKLINE>
Copyright (c) Brian Skinn 2016-2018
Copyright (c) Brian Skinn 2016-2019
License: The MIT License
<BLANKLINE>
Bug reports & feature requests: https://github.com/bskinn/sphobjinv
Expand Down
2 changes: 1 addition & 1 deletion doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@

# General information about the project.
project = 'sphobjinv'
copyright = '2016-2018, Brian Skinn'
copyright = '2016-2019, Brian Skinn'
author = 'Brian Skinn'

# The version info for the project you're documenting, acts as replacement for
Expand Down
9 changes: 7 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,15 @@
NAME = "sphobjinv"


version_override = "2.0"


def readme():
with open("README.rst", "r") as f:
content = f.read()

new_ver = version_override if version_override else __version__

# Helper function
def content_update(content, pattern, sub):
return re.sub(pattern, sub, content, flags=re.M | re.I)
Expand All @@ -19,14 +24,14 @@ def content_update(content, pattern, sub):
content = content_update(
content,
r"(?<=/readthedocs/{0}/)\S+?(?=\.svg$)".format(NAME),
"v" + __version__,
"v" + new_ver,
)

# This one gets the RtD links
content = content_update(
content,
r"(?<={0}\.readthedocs\.io/en/)\S+?(?=/)".format(NAME),
"v" + __version__,
"v" + new_ver,
)

return content
Expand Down
4 changes: 2 additions & 2 deletions sphobjinv/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
17 May 2016
**Copyright**
\(c) Brian Skinn 2016-2018
\(c) Brian Skinn 2016-2019
**Source Repository**
http://www.github.com/bskinn/sphobjinv
Expand Down Expand Up @@ -61,4 +61,4 @@
from .zlib import compress, decompress


__version__ = "2.0"
__version__ = "2.0.1rc1"
4 changes: 2 additions & 2 deletions sphobjinv/cmdline.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
17 May 2016
**Copyright**
\(c) Brian Skinn 2016-2018
\(c) Brian Skinn 2016-2019
**Source Repository**
http://www.github.com/bskinn/sphobjinv
Expand Down Expand Up @@ -44,7 +44,7 @@
#: Version &c. output blurb
VER_TXT = (
"\nsphobjinv v{0}\n\n".format(__version__)
+ "Copyright (c) Brian Skinn 2016-2018\n"
+ "Copyright (c) Brian Skinn 2016-2019\n"
"License: The MIT License\n\n"
"Bug reports & feature requests:"
" https://github.com/bskinn/sphobjinv\n"
Expand Down
2 changes: 1 addition & 1 deletion sphobjinv/data.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
7 Nov 2017
**Copyright**
\(c) Brian Skinn 2016-2018
\(c) Brian Skinn 2016-2019
**Source Repository**
http://www.github.com/bskinn/sphobjinv
Expand Down
2 changes: 1 addition & 1 deletion sphobjinv/error.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
5 Nov 2017
**Copyright**
\(c) Brian Skinn 2016-2018
\(c) Brian Skinn 2016-2019
**Source Repository**
http://www.github.com/bskinn/sphobjinv
Expand Down
2 changes: 1 addition & 1 deletion sphobjinv/fileops.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
5 Nov 2017
**Copyright**
\(c) Brian Skinn 2016-2018
\(c) Brian Skinn 2016-2019
**Source Repository**
http://www.github.com/bskinn/sphobjinv
Expand Down
2 changes: 1 addition & 1 deletion sphobjinv/inventory.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
7 Dec 2017
**Copyright**
\(c) Brian Skinn 2016-2018
\(c) Brian Skinn 2016-2019
**Source Repository**
http://www.github.com/bskinn/sphobjinv
Expand Down
2 changes: 1 addition & 1 deletion sphobjinv/re.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
5 Nov 2017
**Copyright**
\(c) Brian Skinn 2016-2018
\(c) Brian Skinn 2016-2019
**Source Repository**
http://www.github.com/bskinn/sphobjinv
Expand Down
2 changes: 1 addition & 1 deletion sphobjinv/schema.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
7 Dec 2017
**Copyright**
\(c) Brian Skinn 2016-2018
\(c) Brian Skinn 2016-2019
**Source Repository**
http://www.github.com/bskinn/sphobjinv
Expand Down
2 changes: 1 addition & 1 deletion sphobjinv/test/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# bskinn@alum.mit.edu
#
# Created: 29 Oct 2017
# Copyright: (c) Brian Skinn 2016-2018
# Copyright: (c) Brian Skinn 2016-2019
# License: The MIT License; see "LICENSE.txt" for full license terms.
#
# https://www.github.com/bskinn/sphobjinv
Expand Down
2 changes: 1 addition & 1 deletion sphobjinv/test/sphobjinv_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# bskinn@alum.mit.edu
#
# Created: 18 Dec 2017
# Copyright: (c) Brian Skinn 2016-2018
# Copyright: (c) Brian Skinn 2016-2019
# License: The MIT License; see "LICENSE.txt" for full license terms.
#
# https://www.github.com/bskinn/sphobjinv
Expand Down
2 changes: 1 addition & 1 deletion sphobjinv/test/sphobjinv_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# bskinn@alum.mit.edu
#
# Created: 29 Oct 2017
# Copyright: (c) Brian Skinn 2016-2018
# Copyright: (c) Brian Skinn 2016-2019
# License: The MIT License; see "LICENSE.txt" for full license terms.
#
# https://www.github.com/bskinn/sphobjinv
Expand Down
2 changes: 1 addition & 1 deletion sphobjinv/test/sphobjinv_cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# bskinn@alum.mit.edu
#
# Created: 18 Dec 2017
# Copyright: (c) Brian Skinn 2016-2018
# Copyright: (c) Brian Skinn 2016-2019
# License: The MIT License; see "LICENSE.txt" for full license terms.
#
# https://www.github.com/bskinn/sphobjinv
Expand Down
4 changes: 2 additions & 2 deletions sphobjinv/test/sphobjinv_readme.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
# Author: Brian Skinn
# bskinn@alum.mit.edu
#
# Created: 6 Aug 2018
# Copyright: (c) Brian Skinn 2016-2018
# Created: 6 Aug 2019
# Copyright: (c) Brian Skinn 2016-2019
# License: The MIT License; see "LICENSE.txt" for full license terms.
#
# https://www.github.com/bskinn/sphobjinv
Expand Down
2 changes: 1 addition & 1 deletion sphobjinv/zlib.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
5 Nov 2017
**Copyright**
\(c) Brian Skinn 2016-2018
\(c) Brian Skinn 2016-2019
**Source Repository**
http://www.github.com/bskinn/sphobjinv
Expand Down
2 changes: 1 addition & 1 deletion tests.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# bskinn@alum.mit.edu
#
# Created: 29 Oct 2017
# Copyright: (c) Brian Skinn 2016-2018
# Copyright: (c) Brian Skinn 2016-2019
# License: The MIT License; see "LICENSE.txt" for full license terms.
#
# http://www.github.com/bskinn/sphobjinv
Expand Down

0 comments on commit dc46fe3

Please sign in to comment.