nablarch-document

OSS版Nablarchドキュメントです。

前提

本ドキュメントはSphinxでビルドします。

環境構築

WindowsまたはDockerを想定しています。

Windows

ドキュメントビルド環境

Python 3.6.x 及び以下のプラグインをインストールします。

• Sphinx(1.6.3)
• javasphinx(0.9.15)
• sphinx-rtd-theme(0.2.4)

textlint実行環境

上記に加えて、以下をインストールします。

• Node.js（v16.16.0で動作確認済み）
• npmで依存ライブラリをインストールします。

  npm install

• textlint-plugin-rstの依存ライブラリである docutils-ast-writerをインストールします。

  pip install docutils-ast-writer

linkcheck実行環境

• ドキュメントビルド環境と同一

Docker

ドキュメントビルド環境及びtextlint実行環境及びlinkcheck実行環境

• 以下のコマンドでビルドしたイメージを使用してください。

  docker build -t nablarch-document-build .
  

(補足)動作確認済みDockerホスト

• WSL2 + Docker Desktop for Windows
• プロキシは無し

ドキュメントのビルド方法

Windows

• 日本語ドキュメント

  make html ja

• 英語ドキュメント

  make html en

Docker

• 日本語ドキュメント

  docker run --rm -v <リポジトリをクローンしたディレクトリ(フルパス)>:/root/document nablarch-document-build /bin/bash -c "cd /root/document; sphinx-build -d _build/.doctrees/ja -b html ja _build/html"

• 英語ドキュメント

  docker run --rm -v <リポジトリをクローンしたディレクトリ(フルパス)>:/root/document nablarch-document-build /bin/bash -c "cd /root/document; sphinx-build -d _build/.doctrees/en -b html en _build/html/en"

textlintの実行方法

textlintの設定ファイル

• 以下の設定ファイルを使用します。編集する必要はありません。

  ファイル	説明
  .textlintrc	textlintの設定
  .textlint/conf/prh.yml	辞書

疎通確認

Windows

• 日本語ドキュメント

  ./node_modules/.bin/textlint .textlint/test/test.rst

  ./node_modules/.binをPATHに設定しておくと、以下のように実行できます。

  textlint .textlint/test/test.rst

Docker

• 日本語ドキュメント

  docker run --rm -v <リポジトリをクローンしたディレクトリ(フルパス)>:/root/document nablarch-document-build /bin/bash -c "cd /root/document; ../node_modules/.bin/textlint .textlint/test/test.rst"

実行

Windows

• 対象ディレクトリを指定してtextlintを起動します。

  ./node_modules/.bin/textlint ja/development_tools

Docker

• 対象ディレクトリを指定してtextlintを起動します。

  docker run --rm -v <リポジトリをクローンしたディレクトリ(フルパス)>:/root/document nablarch-document-build /bin/bash -c "cd /root/document; ../node_modules/.bin/textlint ja/development_tools"

linkcheckの実行方法

実行

Docker

• 日本語ドキュメント

  docker run --rm -v <リポジトリをクローンしたディレクトリ(フルパス)>:/root/document nablarch-document-build /bin/bash -c "cd /root/document; sphinx-build -d _build/.doctrees/ja -b linkcheck ja _build/linkcheck/ja"

• 英語ドキュメント

  docker run --rm -v <リポジトリをクローンしたディレクトリ(フルパス)>:/root/document nablarch-document-build /bin/bash -c "cd /root/document; sphinx-build -d _build/.doctrees/en -b linkcheck en _build/linkcheck/en"