「ローカルでのドキュメンテーションの構築方法」の版間の差分

提供: tezos-wiki
移動先: 案内検索
(ページの作成:「 ----- Building documentation locally ****************************** The documenation is available online at <code>doc.tzalpha.net <http://doc.tzalpha.net/></code...」)
 
 
1行目: 1行目:
 
 
-----
 
-----
  
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>''.
+
ドキュメントは、<code> doc.tzalpha.net <http://doc.tzalpha.net/&gt; </code> ''のオンラインで入手でき、<code> Gitlab <https: //gitlab.com/tezos/tezos&gt; </code> ''
  
== Building instructions ==
+
==建築指示==
  
To build the documentation, you can use the main Makefile target <code>doc-html</code>
+
ドキュメントをビルドするには、メインのMakefileターゲット<code> doc-html </code>
  
.. code:: bash
+
..コード:: bash
  
<pre>make doc-html</pre>
+
<pre> make doc-html </pre>
The documentation is built by Sphinx, and uses the Read The Docs theme.
+
ドキュメントはSphinxによって作成され、Read The Docsテーマを使用します。
  
On a debian system, you can install the needed dependencies with:
+
Debianシステムでは、以下のものを使って必要な依存関係をインストールすることができます。
  
.. code:: bash
+
..コード:: 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``` 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-src: `name```または</code>:package-src:<code> text&lt; name&gt;` `は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
+
* <code>:package: `name```または</code>:package:<code> text&lt; name&gt;` ``はodocページを指します。 、gitlabソースツリービューア
* <code>:package-name:`name``` or</code>:package-name:`text<name>``` just displays the package name (no link), checking that the package exists
+
パッケージ名: `text <name>` ``はパッケージ名(リンクなし)を表示し、パッケージが存在することを確認するだけです
* <code>:src:`/path/to/file/or/dir``` or</code>:src:`text</path/to/file/or/dir>``` points to the gitlab source tree viewer
+
src: `text </path / to / file / or / dir>` ``はgitlabを指します。ソースツリービューア
* <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``)
+
opam: `text <package>` <code><code> opam.ocaml.org <code>のパッケージページを指しています。バージョン番号は<code> opam: `package``または</code>サポートされています(</code> package.version``
  
== OCaml documentation ==
+
== OCamlドキュメント==
  
Odoc is used for OCaml API generation, that you can install with:
+
OdocはOCaml APIの生成に使用され、次のものでインストールできます。
  
.. code:: bash
+
..コード:: bash
  
<pre>opam install odoc</pre>
+
<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.
+
TezosはすべてのライブラリのAPIドキュメントをHTML形式で生成します。 <code> _build /&lt; context&gt; / _ doc </code>に生成されたHTMLページ。これは、パブリックライブラリごとに1つのサブディレクトリを作成し、各サブディレクトリに<code> index.html </code>ファイルを生成します。
  
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.
+
このドキュメントは、Tezosによってシステムにインストールされていません。これは、開発中にローカルで読んでから、パッケージをリリースするときにwwwに公開されることを意図しています。

2018年5月31日 (木) 00:38時点における最新版


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

ドキュメントは、 doc.tzalpha.net <http://doc.tzalpha.net/> のオンラインで入手でき、 Gitlab <https: //gitlab.com/tezos/tezos>

建築指示[編集]

ドキュメントをビルドするには、メインのMakefileターゲット doc-html

..コード:: bash

 make doc-html 

ドキュメントはSphinxによって作成され、Read The Docsテーマを使用します。

Debianシステムでは、以下のものを使って必要な依存関係をインストールすることができます。

..コード:: bash

 sudo apt install \
??python3-recommonmark \
??python3-sphinx \
??python3-sphinx-rtd-theme 

スフィンクス拡張子[編集]

いくつかのアドホックリファレンスがサポートされています。

  • :package-src: `name```または:package-src: text&lt; name&gt;` `はgitlabソースツリービューアを指します。パッケージが配置されている場所
  • <code>:package: `name```または:package: text&lt; name&gt;` ``はodocページを指します。 、gitlabソースツリービューア

パッケージ名: `text <name>` ``はパッケージ名(リンクなし)を表示し、パッケージが存在することを確認するだけです src: `text </path / to / file / or / dir>` ``はgitlabを指します。ソースツリービューア opam: `text <package>` <code>は<code> opam.ocaml.org <code>のパッケージページを指しています。バージョン番号は<code> opam: `package``またはサポートされています(</code> package.version``)

OCamlドキュメント[編集]

OdocはOCaml APIの生成に使用され、次のものでインストールできます。

..コード:: bash

 opam install odoc 

TezosはすべてのライブラリのAPIドキュメントをHTML形式で生成します。 _build /&lt; context&gt; / _ doc に生成されたHTMLページ。これは、パブリックライブラリごとに1つのサブディレクトリを作成し、各サブディレクトリに index.html ファイルを生成します。

このドキュメントは、Tezosによってシステムにインストールされていません。これは、開発中にローカルで読んでから、パッケージをリリースするときにwwwに公開されることを意図しています。