「ローカルでのドキュメンテーションの構築方法」の版間の差分
(ページの作成:「 ----- Building documentation locally ****************************** The documenation is available online at <code>doc.tzalpha.net <http://doc.tzalpha.net/></code...」) |
|||
1行目: | 1行目: | ||
− | |||
----- | ----- | ||
− | + | ドキュメントをローカルに作成する***************************** | |
− | + | ドキュメントは、<code> doc.tzalpha.net <http://doc.tzalpha.net/> </code> ''のオンラインで入手でき、<code> Gitlab <https: //gitlab.com/tezos/tezos> </code> '' | |
− | == | + | ==建築指示== |
− | + | ドキュメントをビルドするには、メインのMakefileターゲット<code> doc-html </code> | |
− | .. | + | ..コード:: bash |
− | <pre>make doc-html</pre> | + | <pre> make doc-html </pre> |
− | The | + | ドキュメントはSphinxによって作成され、Read The Docsテーマを使用します。 |
− | + | Debianシステムでは、以下のものを使って必要な依存関係をインストールすることができます。 | |
− | .. | + | ..コード:: bash |
− | <pre>sudo apt install \ | + | <pre> sudo apt install \ |
− | + | ??python3-recommonmark \ | |
− | + | ??python3-sphinx \ | |
− | + | ??python3-sphinx-rtd-theme </pre> | |
− | == | + | ==スフィンクス拡張子== |
− | + | いくつかのアドホックリファレンスがサポートされています。 | |
− | * <code> | + | * <code>:package-src: `name```または</code>:package-src:<code> text&lt; name&gt;` `はgitlabソースツリービューアを指します。パッケージが配置されている場所 |
− | * <code> | + | * <code>:package: `name```または</code>:package:<code> 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>サポートされています(</code> package.version``) | |
− | == | + | == OCamlドキュメント== |
− | + | OdocはOCaml APIの生成に使用され、次のものでインストールできます。 | |
− | .. | + | ..コード:: 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によってシステムにインストールされていません。これは、開発中にローカルで読んでから、パッケージをリリースするときに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に公開されることを意図しています。