Release 0.8b1

Author: humitos

CHANGELOG.rst

@@ -0,0 +1,21 @@
+Changelog
+=========
+
+This page shows all the changes done on each version.
+
+
+Version 0.8b1
+-------------
+
+* Move from TravisCI to CircleCI
+* Use Read the Docs' Embed APIv3
+* Stop adding ``data-`` attributes to HTML nodes
+* Do not require ``hoverxref_project`` and ``hoverxref_version`` defined anymore
+* Simplify code by removing ``HoverXRefHTMLTranslatorMixin`` override required and utils functions to get xref data
+* Add new config ``hoverxref_sphinx_version`` used to send to Embed APIv3
+* Update all Python requirements
+* Remove via Javascript the ``title=`` property on Intersphinx references
+* Support for ``glossary``/``term`` added
+* Support for ``sphinxcontrib-bibtex`` added
+* Improve documentation to show examples of documentation not hosted on Read the Docs
+* Use regular expressions on tests to allow partial matching when required

MANIFEST.in

@@ -16,3 +16,5 @@ include hoverxref/_static/js/micromodal.min.js
 include hoverxref/_static/css/micromodal.css
 include hoverxref/_static/css/sphinx_material.css
 include hoverxref/_static/css/sphinx_rtd_theme.css
+
+prune tests

docs/index.rst

@@ -86,6 +86,7 @@ Badges:
    usage
    configuration
    development
+   releasing
 
 
 .. toctree::

docs/releasing.rst

@@ -0,0 +1,16 @@
+Releasing a new version
+=======================
+
+These are the steps needed to release a new version:
+
+#. Increment the version in ``hoverxerf/__init__.py``
+#. Update the ``CHANGELOG.rst``
+#. Commit the changes: ``git commit -m "Release $NEW_VERSION"``
+#. Tag the release in git: ``git tag $NEW_VERSION``
+#. Push the tag to GitHub: ``git push --tags origin``
+#. Upload the package to PyPI::
+
+     $ rm -rf dist/ build/
+     $ pip install twine build
+     $ python -m build --wheel --sdist
+     $ twine upload dist/*

hoverxref/__init__.py

@@ -1 +1 @@
-version = '0.7b1'
+version = '0.8b1'

setup.py

@@ -13,7 +13,7 @@
     description='Sphinx extension to embed content in a tooltip on xref hover',
     url='https://github.com/readthedocs/sphinx-hoverxref',
     license='MIT',
-    packages=setuptools.find_packages(),
+    packages=setuptools.find_packages(exclude=['common', 'tests']),
     long_description=long_description,
     long_description_content_type='text/x-rst',
     include_package_data=True,