version added

docs/Makefile

-SPHINXOPTS  =
-SPHINXBUILD = sphinx-build
-SPHINXPROJ  = pytorch_scatter
-SOURCEDIR   = source
-BUILDDIR    = build
-
-# Put it first so that `make` without argument is like `make help`.
-help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+SPHINXBUILD := sphinx-build
+SPHINXPROJ := pytorch_scatter
+SOURCEDIR := source
+BUILDDIR := build
 
 .PHONY: help Makefile
 
 %: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)"

docs/source/conf.py

-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-
 import os
 import sys
 import datetime
@@ -8,143 +5,26 @@ import sphinx_rtd_theme
 
 sys.path.insert(0, os.path.abspath('../..'))
 
-# -- General configuration ------------------------------------------------
+from torch_scatter import __version__
 
 extensions = [
     'sphinx.ext.autodoc',
-    'sphinx.ext.autosummary',
     'sphinx.ext.doctest',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.todo',
-    'sphinx.ext.coverage',
     'sphinx.ext.mathjax',
     'sphinx.ext.napoleon',
     'sphinx.ext.viewcode',
     'sphinx.ext.githubpages',
 ]
 
-templates_path = ['_templates']
 source_suffix = '.rst'
 master_doc = 'index'
 
-# General information about the project.
 project = 'pytorch_scatter'
 copyright = '{}, Matthias Fey'.format(datetime.datetime.now().year)
 author = 'Matthias Fey'
 
-# 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.1.0'
-# The full version, including alpha/beta/rc tags.
-release = '0.1.0'
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#
-# This is also used if you do content translation via gettext catalogs.
-# Usually you set "language" from the command line for these cases.
-language = None
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = []
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
-
-# If true, `todo` and `todoList` produce output, else they produce nothing.
-todo_include_todos = True
-
-# -- Options for HTML output ----------------------------------------------
+version = __version__
+release = __version__
 
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
 html_theme = 'sphinx_rtd_theme'
 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
-
-# Theme options are theme-specific and customize the look and feel of a theme
-# further.  For a list of options available for each theme, see the
-# documentation.
-#
-html_theme_options = {
-    'collapse_navigation': False,
-    'display_version': True,
-    'logo_only': True,
-}
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-# html_logo = '_static/img/logo.svg'
-# html_static_path = ['_static']
-# html_context = {'css_files': ['_static/css/custom.css']}
-
-# Custom sidebar templates, must be a dictionary that maps document names
-# to template names.
-#
-# This is required for the alabaster theme
-# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
-html_sidebars = {
-    '**': [
-        'relations.html',  # needs 'show_related': True theme option to display
-        'searchbox.html',
-    ]
-}
-
-# -- Options for HTMLHelp output ------------------------------------------
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'pytorch_scatter_doc'
-
-# -- Options for LaTeX output ---------------------------------------------
-
-latex_elements = {
-    # The paper size ('letterpaper' or 'a4paper').
-    #
-    # 'papersize': 'letterpaper',
-
-    # The font size ('10pt', '11pt' or '12pt').
-    #
-    # 'pointsize': '10pt',
-
-    # Additional stuff for the LaTeX preamble.
-    #
-    # 'preamble': '',
-
-    # Latex figure (float) alignment
-    #
-    # 'figure_align': 'htbp',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-#  author, documentclass [howto, manual, or own class]).
-latex_documents = [
-    (master_doc, 'pytorch_scatter.tex', 'pytorch\\_scatter Documentation',
-     'Matthias Fey', 'manual'),
-]
-
-# -- Options for manual page output ---------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [(master_doc, 'pytorch_scatter', 'pytorch_scatter Documentation',
-              [author], 1)]
-
-# -- Options for Texinfo output -------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-#  dir menu entry, description, category)
-texinfo_documents = [
-    (master_doc, 'pytorch_scatter', 'pytorch_scatter Documentation', author,
-     'pytorch_scatter', 'One line description of project.', 'Miscellaneous'),
-]
-
-# Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/': None}

setup.py

@@ -2,6 +2,7 @@ from os import path as osp
 from setuptools import setup, find_packages
 
 import build  # noqa
+from torch_scatter import __version__
 
 install_requires = ['cffi']
 setup_requires = ['pytest-runner', 'cffi']
@@ -10,7 +11,7 @@ docs_require = ['Sphinx', 'sphinx_rtd_theme']
 
 setup(
     name='torch_scatter',
-    version='0.1',
+    version=__version__,
     description='PyTorch extension for various scatter methods',
     url='https://github.com/rusty1s/pytorch_scatter',
     author='Matthias Fey',

torch_scatter/__init__.py

+from .version import __version__  # noqa
 from .functions import *  # noqa

torch_scatter/functions/add.py

@@ -9,7 +9,7 @@ def scatter_add_(output, index, input, dim=0):
     :attr:`dim`. For each value in :attr:`input`, its output index is specified
     by its index in :attr:`input` for dimensions outside of :attr:`dim` and by
     the corresponding value in :attr:`index` for dimension :attr:`dim`. If
-    multiple indices reference the same location, their contributions add.
+    multiple indices reference the same location, their **contributions add**.
 
     If :attr:`input` and :attr:`index` are n-dimensional tensors with size
     :math:`(x_0, ..., x_{i-1}, x_i, x_{i+1}, ..., x_{n-1})` and

torch_scatter/version.py

+__version__ = '0.1.0'