diff --git a/.gitignore b/.gitignore index 7fa536bf7ea496d40bb0fe3775c746d175a30582..f59faf029a7f4013cb03bde4a6f6f8cd79c20808 100644 --- a/.gitignore +++ b/.gitignore @@ -12,3 +12,4 @@ # Build-related directories build dist +_build diff --git a/dev-requirements.txt b/dev-requirements.txt new file mode 100644 index 0000000000000000000000000000000000000000..fdfabd173048d77ae518bb47a74866ff8a5a7143 --- /dev/null +++ b/dev-requirements.txt @@ -0,0 +1,2 @@ +beanbag-docutils>=1.2 +Sphinx>=1.4.8 diff --git a/docs/releasenotes/0.5-beta-1.rst b/docs/releasenotes/0.5-beta-1.rst new file mode 100644 index 0000000000000000000000000000000000000000..be09c8df1cf205890b469e8f7b5ce495f77b23d2 --- /dev/null +++ b/docs/releasenotes/0.5-beta-1.rst @@ -0,0 +1,39 @@ +================================================== +Review Board Integrations 0.5 Beta 1 Release Notes +================================================== + +**Release date**: TBA + + +New Features +============ + +Slack Integration +----------------- + +RBIntegrations includes support for integration with `Slack`_, a team +communication service. It can be configured to communicate with one or more +Slack channels, as well as customize what event notifications are sent. + +.. figure:: _static/images/0.5/0.5-example-notification.png + :alt: Example Slack Notification + + An example Slack notification + + +.. figure:: _static/images/0.5/0.5-example-configuration.png + :alt: Example Integration Configuration + + An example integration configuration. This configuration only sends + notifications when changes are made to public review requests. + + +.. _Slack: https://slack.com + + +Contributors +============ + +* Barret Rennie +* Christian Hammond +* David Trowbridge diff --git a/docs/releasenotes/Makefile b/docs/releasenotes/Makefile new file mode 100644 index 0000000000000000000000000000000000000000..4d03bbdd6bef23f9e320e70314eee18ef064e58d --- /dev/null +++ b/docs/releasenotes/Makefile @@ -0,0 +1,225 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " applehelp to make an Apple Help Book" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " epub3 to make an epub3" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " coverage to run coverage check of the documentation (if enabled)" + @echo " dummy to check syntax errors of document sources" + +.PHONY: clean +clean: + rm -rf $(BUILDDIR)/* + +.PHONY: html +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +.PHONY: dirhtml +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +.PHONY: singlehtml +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +.PHONY: pickle +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +.PHONY: json +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +.PHONY: htmlhelp +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +.PHONY: qthelp +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ReleaseNotes.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ReleaseNotes.qhc" + +.PHONY: applehelp +applehelp: + $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp + @echo + @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." + @echo "N.B. You won't be able to view it unless you put it in" \ + "~/Library/Documentation/Help or install it in your application" \ + "bundle." + +.PHONY: devhelp +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/ReleaseNotes" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ReleaseNotes" + @echo "# devhelp" + +.PHONY: epub +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +.PHONY: epub3 +epub3: + $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3 + @echo + @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3." + +.PHONY: latex +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +.PHONY: latexpdf +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: latexpdfja +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: text +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +.PHONY: man +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +.PHONY: texinfo +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +.PHONY: info +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +.PHONY: gettext +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +.PHONY: changes +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +.PHONY: linkcheck +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +.PHONY: doctest +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +.PHONY: coverage +coverage: + $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage + @echo "Testing of coverage in the sources finished, look at the " \ + "results in $(BUILDDIR)/coverage/python.txt." + +.PHONY: xml +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +.PHONY: pseudoxml +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." + +.PHONY: dummy +dummy: + $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy + @echo + @echo "Build finished. Dummy builder generates no files." diff --git a/docs/releasenotes/_ext/extralinks.py b/docs/releasenotes/_ext/extralinks.py new file mode 100644 index 0000000000000000000000000000000000000000..0c1c134bcccd87a16677ddb27e7235acf1f70e69 --- /dev/null +++ b/docs/releasenotes/_ext/extralinks.py @@ -0,0 +1,47 @@ +"""Sphinx plugins for special links in the Release Notes.""" + +from __future__ import unicode_literals + +from docutils import nodes, utils + + +def setup(app): + app.add_config_value('bugtracker_url', '', True) + app.add_role('bug', bug_role) + app.add_role('cve', cve_role) + + +def bug_role(role, rawtext, text, linenum, inliner, options={}, content=[]): + try: + bugnum = int(text) + if bugnum <= 0: + raise ValueError + except ValueError: + msg = inliner.reporter.error( + 'Bug number must be a number greater than or equal to 1; ' + '"%s" is invalid.' % text, + line=linenum) + prb = inliner.problematic(rawtext, rawtext, msg) + return [prb], [msg] + + bugtracker_url = inliner.document.settings.env.config.bugtracker_url + + if not bugtracker_url or '%s' not in bugtracker_url: + msg = inliner.reporter.error('bugtracker_url must be configured.', + line=linenum) + prb = inliner.problematic(rawtext, rawtext, msg) + return [prb], [msg] + + ref = bugtracker_url % bugnum + node = nodes.reference(rawtext, 'Bug #' + utils.unescape(text), + refuri=ref, **options) + + return [node], [] + + +def cve_role(role, rawtext, text, linenum, inliner, options={}, content=[]): + ref = 'http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-%s' % text + node = nodes.reference(rawtext, 'CVE-' + utils.unescape(text), + refuri=ref, **options) + + return [node], [] diff --git a/docs/releasenotes/_static/images/0.5/0.5-example-configuration.png b/docs/releasenotes/_static/images/0.5/0.5-example-configuration.png new file mode 100644 index 0000000000000000000000000000000000000000..6e408efd8a21a82d0858cdd377c15255411494fa Binary files /dev/null and b/docs/releasenotes/_static/images/0.5/0.5-example-configuration.png differ diff --git a/docs/releasenotes/_static/images/0.5/0.5-example-configuration@2x.png b/docs/releasenotes/_static/images/0.5/0.5-example-configuration@2x.png new file mode 100644 index 0000000000000000000000000000000000000000..27b7ce5a0997145426f0b58d414e1e2f26a34bc6 Binary files /dev/null and b/docs/releasenotes/_static/images/0.5/0.5-example-configuration@2x.png differ diff --git a/docs/releasenotes/_static/images/0.5/0.5-example-notification.png b/docs/releasenotes/_static/images/0.5/0.5-example-notification.png new file mode 100644 index 0000000000000000000000000000000000000000..1adc5c3670bc0c6dd53a81b02e18c9a9910bc1ea Binary files /dev/null and b/docs/releasenotes/_static/images/0.5/0.5-example-notification.png differ diff --git a/docs/releasenotes/_static/images/0.5/0.5-example-notification@2x.png b/docs/releasenotes/_static/images/0.5/0.5-example-notification@2x.png new file mode 100644 index 0000000000000000000000000000000000000000..953437afb1ebb40a88c6b5563b1777a4a7e502e8 Binary files /dev/null and b/docs/releasenotes/_static/images/0.5/0.5-example-notification@2x.png differ diff --git a/docs/releasenotes/conf.py b/docs/releasenotes/conf.py new file mode 100644 index 0000000000000000000000000000000000000000..c22b8a7eb13a7bc758c2490722c3c873c0aa0b32 --- /dev/null +++ b/docs/releasenotes/conf.py @@ -0,0 +1,361 @@ +# -*- coding: utf-8 -*- +# +# Release Notes documentation build configuration file, created by +# sphinx-quickstart on Mon Mar 27 18:32:43 2017. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +from __future__ import unicode_literals + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +import os +import sys +sys.path.insert(0, os.path.abspath('_ext')) + +# Allow Sphinx to find rbintegrations. +sys.path.insert(0, os.path.abspath(os.path.join(__file__, '..', '..', '..'))) + +import rbintegrations + + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.intersphinx', + 'beanbag_docutils.sphinx.ext.django_utils', + 'beanbag_docutils.sphinx.ext.extlinks', + 'beanbag_docutils.sphinx.ext.http_role', + 'beanbag_docutils.sphinx.ext.retina_images', + 'extralinks', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The encoding of source files. +# +# source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = 'Release Notes' +copyright = '2017, Beanbag, Inc.' +author = 'Beanbag, Inc.' +bugtracker_url = 'https://reviewboard.org/bugs/%s' + +# 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 = '.'.join([str(i) for i in rbintegrations.__version_info__[:2]]) +# The full version, including alpha/beta/rc tags. +release = rbintegrations.get_version_string() + +# 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 + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# +# today = '' +# +# Else, today_fmt is used as the format for a strftime call. +# +# today_fmt = '%B %d, %Y' + +# 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 = ['_build', 'Thumbs.db', '.DS_Store'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# +add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# +add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'classic' + +# 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 = {} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. +# " v documentation" by default. +# +html_title = 'Release Notes' + +# A shorter title for the navigation bar. Default is the same as html_title. +# +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# +# html_logo = None + +# The name of an image file (relative to this directory) to use as a favicon of +# the docs. This file should be a Windows icon file (.ico) being 16x16 or +# 32x32 pixels large. +# +# html_favicon = None + +# 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_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# +# html_extra_path = [] + +# If not None, a 'Last updated on:' timestamp is inserted at every page +# bottom, using the given strftime format. +# The empty string is equivalent to '%b %d, %Y'. +# +# html_last_updated_fmt = None + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# +# html_additional_pages = {} + +# If false, no module index is generated. +# +# html_domain_indices = True + +# If false, no index is generated. +# +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh' +# +# html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# 'ja' uses this config value. +# 'zh' user can custom change `jieba` dictionary path. +# +# html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +# +# html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'ReleaseNotesdoc' + +# -- 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, 'ReleaseNotes.tex', 'Release Notes Documentation', + 'Beanbag, Inc.', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# +# latex_use_parts = False + +# If true, show page references after internal links. +# +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# +# latex_appendices = [] + +# If false, will not define \strong, \code, \titleref, \crossref ... but only +# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added +# packages. +# +# latex_keep_old_macro_names = True + +# If false, no module index is generated. +# +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [] + +# If true, show URL addresses after external links. +# +# man_show_urls = False + + +# -- 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 = [] + +# Documents to append as an appendix to all manuals. +# +# texinfo_appendices = [] + +# If false, no module index is generated. +# +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# +# texinfo_no_detailmenu = False + + +# Check whether reviewboard.org intersphinx lookups should use the local +# server. +if os.getenv('DOCS_USE_LOCAL_RBWEBSITE') == '1': + rbwebsite_url = 'http://localhost:8081' +else: + rbwebsite_url = 'https://www.reviewboard.org' + + +# Add references for intersphinx and custom roles. +intersphinx_mapping = { + 'python': ('https://docs.python.org/2.7', None), + 'rb3.0': ('%s/docs/manual/3.0/' % rbwebsite_url, None), +} diff --git a/docs/releasenotes/index.rst b/docs/releasenotes/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..53daf9596780da3bc42415f36ad2ab42bd7d0187 --- /dev/null +++ b/docs/releasenotes/index.rst @@ -0,0 +1,13 @@ +.. _rb-integrations_notes: + +======================================= +Review Board Integrations Release Notes +======================================= + +0.5 Releases +============ + +.. toctree:: + :maxdepth: 1 + + 0.5-beta-1 diff --git a/rbintegrations/__init__.py b/rbintegrations/__init__.py index 1cc127924f7648476a6970cd63a21d963fecac7e..ad1fb0171beb5bb28cf89b774834fdcb7e95eeca 100644 --- a/rbintegrations/__init__.py +++ b/rbintegrations/__init__.py @@ -13,7 +13,7 @@ from __future__ import unicode_literals #: #: (Major, Minor, Micro, Patch, alpha/beta/rc/final, Release Number, Released) #: -VERSION = (0, 1, 0, 0, 'alpha', 0, False) +VERSION = (0, 5, 0, 0, 'beta', 1, False) def get_version_string():