「ローカルでのドキュメンテーションの構築方法」を編集中


-----

Building documentation locally ******************************

The documenation is available online at <code>doc.tzalpha.net &lt;http://doc.tzalpha.net/&gt;</code>'', always up to date with master on <code>Gitlab &lt;https://gitlab.com/tezos/tezos&gt;</code>''.

== Building instructions ==

To build the documentation, you can use the main Makefile target <code>doc-html</code>

.. code:: bash

<pre>make doc-html</pre>
The documentation is built by Sphinx, and uses the Read The Docs theme.

On a debian system, you can install the needed dependencies with:

.. code:: bash

<pre>sudo apt install \
  python3-recommonmark \
  python3-sphinx \
  python3-sphinx-rtd-theme</pre>
== Sphinx extensions ==

Some ad-hoc reference kinds are supported.

* <code>:package-src:`name``` or</code>:package-src:<code>text&lt;name&gt;``` points   to the gitlab source tree viewer where the</code>.opam` for the package is located
* <code>:package:`name``` or</code>:package:<code>text&lt;name&gt;``` now points   either to the</code>odoc` page, or if it doesn't exist, to the gitlab source tree viewer
* <code>:package-name:`name``` or</code>:package-name:`text<name>``` just displays the package name (no link), checking that the package exists
* <code>:src:`/path/to/file/or/dir``` or</code>:src:`text</path/to/file/or/dir>``` points to the gitlab source tree viewer
* <code>:opam:`package``` or</code>:opam:`text<package>`<code>points to the   package page on</code>opam.ocaml.org<code>, version number is supported   (</code>package.version``)

== OCaml documentation ==

Odoc is used for OCaml API generation, that you can install with:

.. code:: bash

<pre>opam install odoc</pre>
Tezos generates the API documentation for all libraries in HTML format. The generated HTML pages in <code>_build/&lt;context&gt;/_doc</code>. It creates one sub-directory per public library and generates an <code>index.html</code> file in each sub-directory.

The documentation is not installed on the system by Tezos. It is meant to be read locally while developing and then published on the www when releasing packages.
@@ 1行目: / 1行目: @@
 -----
-ドキュメントをローカルに作成する*****************************
+Building documentation locally ******************************
-ドキュメントは、<code> doc.tzalpha.net <http：//doc.tzalpha.net/&gt; </code> ''のオンラインで入手でき、<code> Gitlab <https： //gitlab.com/tezos/tezos&gt; </code> ''
+The documenation is available online at <code>doc.tzalpha.net &lt;http://doc.tzalpha.net/&gt;</code>'', always up to date with master on <code>Gitlab &lt;https://gitlab.com/tezos/tezos&gt;</code>''.
-==建築指示==
+== Building instructions ==
-ドキュメントをビルドするには、メインのMakefileターゲット<code> doc-html </code>
+To build the documentation, you can use the main Makefile target <code>doc-html</code>
-..コード:: bash
+.. code:: bash
-<pre> make doc-html </pre>
+<pre>make doc-html</pre>
-ドキュメントはSphinxによって作成され、Read The Docsテーマを使用します。
+The documentation is built by Sphinx, and uses the Read The Docs theme.
-Debianシステムでは、以下のものを使って必要な依存関係をインストールすることができます。
+On a debian system, you can install the needed dependencies with:
-..コード:: bash
+.. code:: bash
-<pre> sudo apt install \
+<pre>sudo apt install \
-??python3-recommonmark \
+  python3-recommonmark \
-??python3-sphinx \
+  python3-sphinx \
-??python3-sphinx-rtd-theme </pre>
+  python3-sphinx-rtd-theme</pre>
-==スフィンクス拡張子==
+== Sphinx extensions ==
-いくつかのアドホックリファレンスがサポートされています。
+Some ad-hoc reference kinds are supported.
-* <code>：package-src： `name```または</code>：package-src：<code> text＆lt; name＆gt;` `はgitlabソースツリービューアを指します。パッケージが配置されている場所
+* <code>:package-src:`name``` or</code>:package-src:<code>text&lt;name&gt;``` points   to the gitlab source tree viewer where the</code>.opam` for the package is located
-* <code>：package： `name```または</code>：package：<code> text＆lt; name＆gt;` ``はodocページを指します。 、gitlabソースツリービューア
+* <code>:package:`name``` or</code>:package:<code>text&lt;name&gt;``` now points   either to the</code>odoc` page, or if it doesn't exist, to the gitlab source tree viewer
-パッケージ名： `text <name>` ``はパッケージ名（リンクなし）を表示し、パッケージが存在することを確認するだけです
+* <code>:package-name:`name``` or</code>:package-name:`text<name>``` just displays the package name (no link), checking that the package exists
-src： `text </path / to / file / or / dir>` ``はgitlabを指します。ソースツリービューア
+* <code>:src:`/path/to/file/or/dir``` or</code>:src:`text</path/to/file/or/dir>``` points to the gitlab source tree viewer
-opam： `text <package>` <code>は<code> opam.ocaml.org <code>のパッケージページを指しています。バージョン番号は<code> opam： `package``または</code>サポートされています（</code> package.version``）
+* <code>:opam:`package``` or</code>:opam:`text<package>`<code>points to the   package page on</code>opam.ocaml.org<code>, version number is supported   (</code>package.version``)
-== OCamlドキュメント==
+== OCaml documentation ==
-OdocはOCaml APIの生成に使用され、次のものでインストールできます。
+Odoc is used for OCaml API generation, that you can install with:
-..コード:: bash
+.. code:: bash
-<pre> opam install odoc </pre>
+<pre>opam install odoc</pre>
-TezosはすべてのライブラリのAPIドキュメントをHTML形式で生成します。 <code> _build /＆lt; context＆gt; / _ doc </code>に生成されたHTMLページ。これは、パブリックライブラリごとに1つのサブディレクトリを作成し、各サブディレクトリに<code> index.html </code>ファイルを生成します。
+Tezos generates the API documentation for all libraries in HTML format. The generated HTML pages in <code>_build/&lt;context&gt;/_doc</code>. It creates one sub-directory per public library and generates an <code>index.html</code> file in each sub-directory.
-このドキュメントは、Tezosによってシステムにインストールされていません。これは、開発中にローカルで読んでから、パッケージをリリースするときにwwwに公開されることを意図しています。
+The documentation is not installed on the system by Tezos. It is meant to be read locally while developing and then published on the www when releasing packages.