差分

Building documentation locally *ドキュメントをローカルに作成する*****************************

The documenation is available online at ドキュメントは、<code>doc.tzalpha.net &lt;http:<http：//doc.tzalpha.net/&gt;</code>'', always up to date with master on のオンラインで入手でき、<code>Gitlab &lt;https:<https： //gitlab.com/tezos/tezos&gt;</code>''.

== Building instructions 建築指示==

To build the documentation, you can use the main Makefile target ドキュメントをビルドするには、メインのMakefileターゲット<code>doc-html</code>

.. codeコード:: bash

<pre>make doc-html</pre>ドキュメントはSphinxによって作成され、Read The documentation is built by Sphinx, and uses the Read The Docs theme.Docsテーマを使用します。

.. codeコード:: bash

<pre>sudo apt install \ ??python3-recommonmark \ ??python3-sphinx \ ??python3-sphinx-rtd-theme</pre>== Sphinx extensions スフィンクス拡張子==

* <code>:package：package-src:src： `name``` orまたは</code>:package：package-src:src：<code>text&lttext＆lt;name&gtname＆gt;``` points to the gitlab source tree viewer where the</code>.opam` for the package is locatedはgitlabソースツリービューアを指します。パッケージが配置されている場所* <code>:package:：package： `name``` orまたは</code>:package:：package：<code>text&lttext＆lt;name&gtname＆gt;``` now points either to the</code>odoc` page, or if it doesn't exist, to the gitlab source tree viewerはodocページを指します。 、gitlabソースツリービューア* <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:src： `text</path/to/file/or/dir>``` points to the gitlab source tree viewerはgitlabを指します。ソースツリービューア* <code>:opam:`package``` or</code>:opam:opam： `text<package>`<code>points to the package page onは</code>opam.ocaml.org<code>, version number is supported (のパッケージページを指しています。バージョン番号は<code> opam： `package``または</code>サポートされています（</code>package.version``)）

== OCaml documentation OCamlドキュメント==

.. codeコード:: bash

<pre>opam install odoc</pre>Tezos generates the API documentation for all libraries in HTML format. The generated HTML pages in TezosはすべてのライブラリのAPIドキュメントをHTML形式で生成します。 <code>_build/&lt＆lt;context&gtcontext＆gt;/_doc_ doc </code>. It creates one sub-directory per public library and generates an に生成されたHTMLページ。これは、パブリックライブラリごとに1つのサブディレクトリを作成し、各サブディレクトリに<code>index.html</code> file in each sub-directory.ファイルを生成します。