Release process

USAGE.rst

@@ -2,8 +2,7 @@
 Usage
 =====
 
-Select the "Sphinx Wagtail theme" in the `conf.py` file of a Sphinx project like
-so::
+Select the "Sphinx Wagtail theme" in the `conf.py` file of a Sphinx project::
 
    # include the theme in the list of extensions to be loaded
    extensions = ['sphinx_wagtail_theme', …]
@@ -18,7 +17,7 @@ The following snippet should always work if appended at the end of `conf.py`::
 
    try:
       extensions
-   except: NameError
+   except NameError:
       extensions = []
 
    extensions.append('sphinx_wagtail_theme')

docs/conf.py

@@ -1,23 +1,25 @@
-#!/usr/bin/env python
-#
 import os
 import sys
+
+import sphinx_wagtail_theme
+
 sys.path.insert(0, os.path.abspath('..'))
 
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.viewcode',
+    'sphinx_wagtail_theme',
     ]
 templates_path = ['_templates']
 source_suffix = '.rst'
 master_doc = 'index'
 project = 'Sphinx Wagtail theme'
-copyright = "2020, Wagtail documentation team"
-author = "Martin Bless"
+copyright = "2020, Wagtail contributors"
+author = "Wagtail"
 # The short X.Y version.
-version = '0.0'
+version = sphinx_wagtail_theme.__version__
 # The full version, including alpha/beta/rc tags.
-release = '0.0.0'
+release = sphinx_wagtail_theme.__version__
 language = None
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 pygments_style = 'sphinx'
@@ -26,7 +28,7 @@
 today_fmt = '%Y-%m-%d %H:%M'
 
 # -- Options for HTML output -------------------------------------------
-html_theme = 'alabaster'
+html_theme = 'sphinx_wagtail_theme'
 html_static_path = []
 # -- Options for HTMLHelp output ---------------------------------------
 htmlhelp_basename = 'sphinx_wagtail_themedoc'
@@ -52,18 +54,3 @@
      'One line description of project.',
      'Miscellaneous'),
 ]
-# -- what we are doing -------------------------------------------------
-try:
-    import sphinx_wagtail_theme
-    is_imported = True
-except:
-    is_imported = False
-if is_imported:
-    version = sphinx_wagtail_theme.__version__
-    release = sphinx_wagtail_theme.__version__
-    html_theme = 'sphinx_wagtail_theme'
-
-
-
-
-

requirements_dev.txt

@@ -2,7 +2,7 @@ flake8
 pip
 pytest
 setuptools
-setuptools_scm
 sphinx
 twine
 wheel
+zest.releaser

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
-name = sphinx_wagtail_theme-allcaps
-version = 5.0.0-alpha
+name = sphinx_wagtail_theme
+version = 5.0.0-a0
 author = Coen van der Kamp
 author_email = coen@fourdigits.nl
 description = Sphinx Wagtail theme

sphinx_wagtail_theme/__init__.py

@@ -1,16 +1,11 @@
-"""Sphinx Wagtail theme for docs.wagtail.io"""
+"""Sphinx Wagtail theme"""
 
 import os
+import pkg_resources
 
-try:
-    from .static._version_GENERATED import version as __version__
-except ImportError:
-    __version__ = '99.88.77'
 
-try:
-    from .static._version_info_GENERATED import version_info
-except ImportError:
-    version_info = {}
+__version__ = pkg_resources.require("sphinx_wagtail_theme")[0].version
+__version_full__ = __version__
 
 
 def get_html_theme_path():

tests/test_python_sphinx_wagtail_theme.py

@@ -2,27 +2,9 @@
 
 
 def test_theme_info():
-    """Test imported stuff."""
-    sphinx_wagtail_theme.__version__ == "99.88.77"
-    # build_mtime = version_info['build_mtime']
-    # assert int(build_mtime) > 1580000000
-    # module_name = version_info['module_name']
-    # assert module_name == 'sphinx_wagtail_theme'
-    # version_scm = version_info['version_scm']
-    # assert len(version_scm)
-    # assert version_scm == sphinx_wagtail_theme.__version__
-    # version_scm_build = version_info['version_scm_build']
-    # assert type(version_scm_build) == str
-    # version_scm_core = version_info['version_scm_core']
-    # assert len(version_scm_core)
-    # version_scm_pre_release = version_info['version_scm_pre_release']
-    # assert type(version_scm_pre_release) == str
+    assert isinstance(sphinx_wagtail_theme.__version__, str)
+    assert len(sphinx_wagtail_theme.__version__) > 5
 
 
-def test_methods():
-    """Test the module methods."""
-    assert len(sphinx_wagtail_theme.get_html_theme_path())
-    mtime = sphinx_wagtail_theme.get_theme_mtime()
-    assert isinstance(mtime, int)
-    # assert mtime > 1580000000
-    # assert sphinx_wagtail_theme.get_theme_name() == 'sphinx_wagtail_theme'
+def test_module_methods():
+    assert isinstance(sphinx_wagtail_theme.get_html_theme_path(), str)