[JM:02120] Re: ドキュメント編集メモのページを書き直してみました

Back to archive index
Akihiro Motoki amoto****@gmail*****
2021年 3月 30日 (火) 00:57:24 JST


元木です。

http://linuxjm.osdn.jp/guide/document_help.html の変更案にあった部分にだけ
コメントします。それ以外のことについてはコメントしていません。

On Sat, Mar 27, 2021 at 9:25 AM 長南洋一 <cyoic****@maple*****> wrote:

> 必要な sphinx パッケージは debian の場合は、pyton3 版なら、
> python3-sphinx と python3-sphinx-bootstrap-theme、
> python2 なら、python-sphinx と python-sphinx-bootstrap-theme
> です。ubuntu や RedHat 系はどうなんでしょうか。

sphinx-bootstrap-theme は以前は使っていたのですが、今は使っていません。
便利な点もいろいろあったのですが、ページ内の見出しの目次を作ってくれないので、
今は sphinx にもともと用意されているテーマを使うようになっています。
面倒だと思うので、 sphinx-bootstrap-theme に依存している部分は削除しておきます。

> 必要な sphinx パッケージは debian の場合は、pyton3 版なら、
> python3-sphinx と python3-sphinx-bootstrap-theme、
> python2 なら、python-sphinx と python-sphinx-bootstrap-theme
> です。ubuntu や RedHat 系はどうなんでしょうか。

Ubuntu の python3 は同じ名前です。 python2 環境は Ubuntu focal にはないので分かりません。
なお、元のドキュメントを書いたときには、
ディストリビューションごとのことを書くのが面倒だったのと、
osdn シェルサーバーで pip でインストールしないといけなかったので、
pip install を書きました。

> > build 方法
> > ----------
> >
> > カレントディレクトリに、先にダウンロードしたファイルが含まれるディレクトリ
> > jm があるとします。まず、ドキュメントが含まれるサブディレクトリまで移動します。
> > 次に、make を実行し、表示用のファイルを作成します。
>
> ちょっとゴタゴタしてしまったようですね。もっと簡単でよいのではありませんか。
> たとえば、
>
>   ローカルリポジトリの jm/guide に移動し、make を実行して、sphinx の
>   rst ファイルから html ファイルを作成します。

git clone したリポジトリが jm という名前なので、
clone 済みのリポジトリにいる前提なら、 jm/guide ではなく guide に移動する、
でないとおかしいです。

上からきっちりたどると動作するチュートリアルにしようとしているようですが、
レポジトリにいることが前提になっている自分とかから見ると、
cd jm/guide はかなり唐突に思いました。

元の文章だと cd <JM_GIT_REPO_TOP>/guide となっていますが、
これを書いたときは <JM_GIT_REPO_TOP> は絶対パスでも相対パスでも
いいので、読者が読み替えてくださいというつもりでした。

最初の方でこんな感じにしておけばいいのかな。
以下は作業リポジトリ内で作業する前提で。
  git clone ...
  cd jm

> 「ローカルリポジトリ」という言葉が唐突かなあ。まあ、これは例ですから、
> もうちょっと全体のつながりのよい表現を考えてください。

「作業リポジトリ」か「ローカルリポジトリ」くらいだと思います。

では。


linuxjm-discuss メーリングリストの案内
Back to archive index