Skip to content

Commit

Permalink
MAINT: various fixes in preparation for next release.
Browse files Browse the repository at this point in the history
- Remove mentions of pybytes.com/pywavelets (that will forward to
  readthedocs.org once @nigma puts the redirect in place).  Leave the wavelet
  browser links on pybytes.com though.
- Fix dev version string to be PEP 440 compliant.
- Automatically get correct version number into html docs.
- Replace "Filip Wasilewski" with "The PyWavelets Developers" in various
  places.
  • Loading branch information
rgommers committed Jul 29, 2015
1 parent 9670f87 commit 1bad5ba
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 15 deletions.
3 changes: 1 addition & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,7 @@ Documentation
-------------

Documentation with detailed examples and links to more resources is available
online at http://www.pybytes.com/pywavelets/ and
http://pywavelets.readthedocs.org.
online at http://pywavelets.readthedocs.org.

For more usage examples see the `demo`_ directory in the source package.

Expand Down
2 changes: 1 addition & 1 deletion doc/source/_templates/page.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
{% block extrahead %}
{{ super() }}
<meta name="description" content="PyWavelets is a scientific Python module for Wavelet Transform calculations."/>
<meta name="keywords" content="PyWavelets, wavelets, Python, wavelet transform, discrete wavelet transform, dwt, idwt, swt, wavelet packets, stationary wavelet transform, pywt, Filip Wasilewski"/>
<meta name="keywords" content="PyWavelets, wavelets, Python, wavelet transform, discrete wavelet transform, dwt, idwt, swt, wavelet packets, stationary wavelet transform, pywt"/>
<meta name="author" content="Filip Wasilewski"/>
<meta name="Distribution" content="Global"/>
<meta name="Robots" content="INDEX,FOLLOW"/>
Expand Down
3 changes: 1 addition & 2 deletions doc/source/_templates/quicklinks.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,5 @@ <h3>Quick links</h3>
<li><a href="https://github.com/nigma/pywt"><img src="{{ pathto("_static/github.png", 1) }}" height="16" width="16" alt="" /> Fork on Github</a></li>
<li><a href="http://groups.google.com/group/pywavelets"><img src="{{ pathto("_static/comments.png", 1) }}" height="16" width="16" alt="" /> Discussion Group</a></li>
<li><a href="http://wavelets.pybytes.com/"><img src="{{ pathto("_static/wave.png", 1) }}" height="16" width="16" alt="" /> Explore Wavelets</a></li>
<li><a href="http://twitter.com/filipwasilewski"><img src="{{ pathto("_static/twitter.png", 1) }}" height="16" width="16" alt="" /> Follow on Twitter</a></li>
</ul>
</div>
</div>
21 changes: 12 additions & 9 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys, os
import re
import datetime
import jinja2.filters

Expand Down Expand Up @@ -40,16 +40,19 @@

# General information about the project.
project = 'PyWavelets'
copyright = jinja2.filters.do_mark_safe('2006-%s, <a href="http://en.ig.ma/">Filip Wasilewski</a>' % datetime.date.today().year)
copyright = jinja2.filters.do_mark_safe('2006-%s, <a href="https://groups.google.com/forum/#!forum/pywavelets">The PyWavelets Developers</a>' % datetime.date.today().year)

# 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 = '0.2.2'
# The full version, including alpha/beta/rc tags.
release = '0.2.2'

# The default replacements for |version| and |release|, also used in various
# other places throughout the built documents.
import pywt
version = re.sub(r'\.dev-.*$', r'.dev', pywt.__version__)
release = pywt.__version__

print "PyWavelets (VERSION %s)" % (version,)

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down Expand Up @@ -157,7 +160,7 @@
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
html_use_opensearch = 'http://pybytes.com/pywavelets'
html_use_opensearch = 'http://pywavelets.readthedocs.org'

# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = ''
Expand All @@ -178,7 +181,7 @@
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'PyWavelets.tex', 'PyWavelets Documentation',
'Filip Wasilewski', 'manual'),
'The PyWavelets Developers', 'manual'),
]

# The name of an image file (relative to this directory) to place at the top of
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ def get_version_info():
GIT_REVISION = "Unknown"

if not ISRELEASED:
FULLVERSION += '.dev-' + GIT_REVISION[:7]
FULLVERSION += '.dev0+' + GIT_REVISION[:7]

return FULLVERSION, GIT_REVISION

Expand Down

0 comments on commit 1bad5ba

Please sign in to comment.