Skip to content

Commit

Permalink
introduce substitutions and sphinx.ext.extlinks to fulfill latest ver…
Browse files Browse the repository at this point in the history 
…sion automatically
  • Loading branch information
@KengoTODA
KengoTODA committed Oct 15, 2017
1 parent a926c7f commit 7136eb1
Show file tree
Hide file tree
Showing 6 changed files with 41 additions and 28 deletions.
2 changes: 1 addition & 1 deletion RELEASE_PROCEDURE.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ When you release fixed version of SpotBugs, please follow these procedures.
* `version` in `build.gradle` and `gradlePlugin/build.gradle`
* version number in `CHANGELOG.md` and `gradlePlugin/CHANGELOG.md`
* `version` and `full_version` in `docs/conf.py`
* version numbers in `docs/migration.rst`, `docs/introduction.rst` and `docs/installing.rst`
* version numbers in `docs/migration.rst` and `docs/installing.rst`

## Release to Maven Central

Expand Down
6 changes: 6 additions & 0 deletions docs/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -274,3 +274,9 @@ def setup(app):

sys.path.append(os.path.abspath('extensions'))
extensions += ['generate_bug_description']


# URL to distribute SpotBugs package
# http://www.sphinx-doc.org/en/stable/ext/extlinks.html
extensions += ['sphinx.ext.extlinks']
extlinks = {'dist': ('http://repo.maven.apache.org/maven2/com/github/spotbugs/spotbugs/' + release + '/spotbugs-' + release + '.%s', '')}
6 changes: 3 additions & 3 deletions docs/installing.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Extracting the Distribution
---------------------------

The easiest way to install SpotBugs is to download a binary distribution.
Binary distributions are available in `gzipped tar format <http://repo.maven.apache.org/maven2/com/github/spotbugs/spotbugs/3.1.0-RC7/spotbugs-3.1.0-RC7.tgz>`_ and `zip format <http://repo.maven.apache.org/maven2/com/github/spotbugs/spotbugs/3.1.0-RC7/spotbugs-3.1.0-RC7.zip>`_.
Binary distributions are available in :dist:`gzipped tar format <tgz>` and :dist:`zip format <zip>`.
Once you have downloaded a binary distribution, extract it into a directory of your choice.

Extracting a gzipped tar format distribution::
Expand All @@ -18,7 +18,7 @@ Extracting a zip format distribution::

C:\Software> unzip spotbugs-3.1.0-RC7.zip

Usually, extracting a binary distribution will create a directory ending in ``spotbugs-3.1.0-RC7``.
For example, if you extracted the binary distribution from the ``C:\Software directory``, then the SpotBugs software will be extracted into the directory ``C:\Software\spotbugs-3.1.0-RC7``.
Usually, extracting a binary distribution will create a directory ending in spotbugs-|release|.
For example, if you extracted the binary distribution from the C:\\Software directory, then the SpotBugs software will be extracted into the directory C:\\Software\\spotbugs-|release|.
This directory is the SpotBugs home directory.
We'll refer to it as ``$SPOTBUGS_HOME`` (or ``%SPOTBUGS_HOME%`` for Windows) throughout this manual.
2 changes: 1 addition & 1 deletion docs/introduction.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Introduction
SpotBugs is a program to find bugs in Java programs.
It looks for instances of "bug patterns" --- code instances that are likely to be errors.

This document describes version 3.1.0-RC7 of SpotBugs.
This document describes version |release| of SpotBugs.
We are very interested in getting your feedback on SpotBugs.
Please visit the SpotBugs web page for the latest information on SpotBugs, contact information, and support resources such as information about the SpotBugs GitHub organization.

Expand Down
27 changes: 12 additions & 15 deletions docs/locale/ja/LC_MESSAGES/installing.po
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,17 @@
# FIRST AUTHOR <EMAIL@ADDRESS>, 2017.
#
msgid ""
msgstr "Project-Id-Version: spotbugs 3.1\n"
msgstr ""
"Project-Id-Version: spotbugs 3.1\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2017-10-07 22:57+0900\n"
"POT-Creation-Date: 2017-10-14 11:35+0000\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=utf-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.4.0\n"
"Generated-By: Babel 1.3\n"

#: ../../installing.rst:2
msgid "Installing"
Expand All @@ -30,13 +31,10 @@ msgstr "配布物の展開"
#: ../../installing.rst:9
msgid ""
"The easiest way to install SpotBugs is to download a binary distribution."
" Binary distributions are available in `gzipped tar format "
"<http://repo.maven.apache.org/maven2/com/github/spotbugs/spotbugs/3.1.0-RC6/spotbugs-3.1.0-RC6.tgz>`_"
" and `zip format "
"<http://repo.maven.apache.org/maven2/com/github/spotbugs/spotbugs/3.1.0-RC6/spotbugs-3.1.0-RC6.zip>`_."
" Once you have downloaded a binary distribution, extract it into a "
"directory of your choice."
msgstr "SpotBugs をインストールする最も簡単な方法は，バイナリ配布物をダウンロードすることです。バイナリ配布物は `gzipped tar 形式 <http://repo.maven.apache.org/maven2/com/github/spotbugs/spotbugs/3.1.0-RC6/spotbugs-3.1.0-RC6.tgz>`_ と `zip 形式 <http://repo.maven.apache.org/maven2/com/github/spotbugs/spotbugs/3.1.0-RC6/spotbugs-3.1.0-RC6.zip>`_ がそれぞれ入手可能です。バイナリ配布物をダウンロードしたら，任意のディレクトリに展開します。"
" Binary distributions are available in :dist:`gzipped tar format <tgz>` "
"and :dist:`zip format <zip>`. Once you have downloaded a binary "
"distribution, extract it into a directory of your choice."
msgstr ""

#: ../../installing.rst:13
msgid "Extracting a gzipped tar format distribution::"
Expand All @@ -49,11 +47,10 @@ msgstr "zip 形式の展開方法例::"
#: ../../installing.rst:21
msgid ""
"Usually, extracting a binary distribution will create a directory ending "
"in ``spotbugs-3.1.0-RC6``. For example, if you extracted the binary "
"distribution from the ``C:\\Software directory``, then the SpotBugs "
"in spotbugs-|release|. For example, if you extracted the binary "
"distribution from the C:\\\\Software directory, then the SpotBugs "
"software will be extracted into the directory "
"``C:\\Software\\spotbugs-3.1.0-RC6``. This directory is the SpotBugs home"
"C:\\\\Software\\\\spotbugs-|release|. This directory is the SpotBugs home"
" directory. We'll refer to it as ``$SPOTBUGS_HOME`` (or "
"``%SPOTBUGS_HOME%`` for Windows) throughout this manual."
msgstr "バイナリ配布物を展開すると，通常は ``spotbugs-3.1.0-RC6`` で終わるディレクトリが作成されます。たとえば，``C:\\Software`` ディレクトリでバイナリ配布物を展開すると，SpotBugs ソフトウェアは ``C:\\Software\\spotbugs-3.1.0-RC6`` ディレクトリに展開されます。このディレクトリが SpotBugs のホームディレクトリになります。このマニュアルでは，``$SPOTBUGS_HOME`` (Windows では ``%SPOTBUGS_HOME%``) と呼びます。"

msgstr ""
26 changes: 18 additions & 8 deletions docs/locale/ja/LC_MESSAGES/introduction.po
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
# FIRST AUTHOR <EMAIL@ADDRESS>, 2017.
#
msgid ""
msgstr "Project-Id-Version: spotbugs 3.1\n"
msgstr ""
"Project-Id-Version: spotbugs 3.1\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2017-10-07 22:57+0900\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
Expand All @@ -13,7 +14,7 @@ msgstr "Project-Id-Version: spotbugs 3.1\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=utf-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.4.0\n"
"Generated-By: Babel 1.3\n"

#: ../../introduction.rst:2
msgid "Introduction"
Expand All @@ -24,16 +25,22 @@ msgid ""
"SpotBugs is a program to find bugs in Java programs. It looks for "
"instances of \"bug patterns\" --- code instances that are likely to be "
"errors."
msgstr "SpotBugs は，Java プログラムの中のバグを見つけるプログラムです。このプログラムは「バグパターン」のインスタンスを探します。「バグパターン」とは，エラーとなる可能性の高いコードのインスタンスです。"
msgstr ""
"SpotBugs は，Java "
"プログラムの中のバグを見つけるプログラムです。このプログラムは「バグパターン」のインスタンスを探します。「バグパターン」とは，エラーとなる可能性の高いコードのインスタンスです。"

#: ../../introduction.rst:7
msgid ""
"This document describes version 3.1.0-RC6 of SpotBugs. We are very "
"This document describes version |release| of SpotBugs. We are very "
"interested in getting your feedback on SpotBugs. Please visit the "
"SpotBugs web page for the latest information on SpotBugs, contact "
"information, and support resources such as information about the SpotBugs"
" GitHub organization."
msgstr "このドキュメントでは，SpotBugs のバージョン 3.1.0-RC6 について説明します。私たちは，SpotBugs に対するフィードバックを心待ちにしています。SpotBugs の最新情報，連絡先，SpotBugs GitHub 組織に関する情報などのサポートリソースは SpotBugs のウェブページを参照してください。"
msgstr ""
"この文書では，SpotBugs のバージョン |release| "
"について説明します。私たちは，SpotBugs に対するフィードバックを心待ちにしています。SpotBugs "
"の最新情報，連絡先，SpotBugs GitHub 組織に関する情報などのサポートリソースは "
"SpotBugs のウェブページを参照してください。"

#: ../../introduction.rst:12
msgid "Requirements"
Expand All @@ -44,11 +51,14 @@ msgid ""
"To use SpotBugs, you need a runtime environment compatible with Java "
"version 1.8 or later. SpotBugs is platform independent, and is known to "
"run on GNU/Linux, Windows, and MacOS X platforms."
msgstr "SpotBugs を使うためには，Java バージョン 1.8 以降のバージョンと互換性のあるランタイム環境が必要です。SpotBugs は，プラットフォームに依存せず，GNU/Linux，Windows，MacOS X で動作することが知られています。"
msgstr ""
"SpotBugs を使うためには，Java バージョン 1.8 以降のバージョンと互換性のあるランタイム環境が必要です。SpotBugs "
"は，プラットフォームに依存せず，GNU/Linux，Windows，MacOS X で動作することが知られています。"

#: ../../introduction.rst:17
msgid ""
"You should have at least 512 MB of memory to use SpotBugs. To analyze "
"very large projects, more memory may be needed."
msgstr "SpotBugs を使うためには，少なくとも 512MB のメモリが必要です。巨大なプロジェクトを解析するためには，より多くのメモリが必要になることがあります。"

msgstr ""
"SpotBugs を使うためには，少なくとも 512MB "
"のメモリが必要です。巨大なプロジェクトを解析するためには，より多くのメモリが必要になることがあります。"

0 comments on commit 7136eb1

Please sign in to comment.