2016-04-05 11 views
5

プロジェクトCMakeLists.txtファイルとローカルプロジェクト.cmakeファイルを文書化する良い方法は何ですか? 2年前の質問/回答Documenting CMake scriptsがありますが、私は本質的にここで再度尋ねています。答えには文が含まれていますCMakeLists.txtとカスタムまたはローカル.cmakeファイルの文書化

現在、CMake 3.0は開発中です。これは、SphinxとreStructuredTextに基づいた新しいドキュメントシステムを開発します。私はこれがあなたのモジュールを文書化するための新しい方法をもたらすと思います。

私はcmake developer documentation見てきましたが、思わこの新しいドキュメントシステムは、cmakeの自身のドキュメンテーションに向けました。私はユーザー定義のプロジェクトCMakeLists.txtファイルまたはローカル.cmakeファイルを文書化するためにこれをどのように使用することができないのか分かりません。

私は、cmakeプロジェクトが内部的にさまざまなスフィンクスのディレクティブと役割を持っているので、ユーザーとして何らかの方法があることを願っています。このスフィンクスの内部的な使い方を利用することができます。私はCMakeLists.txtファイルにのマークアップと、ファイルを再作成せずにローカルの.cmakeファイルを持たせたいと考えています。他のプロジェクトにも関連する努力があります。例えば、ROS catkinプロジェクトは、私が見てきた最も完全なアプローチを提供しているようですが、非ROSプロジェクトではそれほど使いにくいものではありません。 (一例として、extracted cmake api pageを見てください。)最も簡​​単なのはsphinx-contribですが、autodocのアプローチではなく、別の最初のソースドキュメントに依存しています。

これはおそらくcmakeリストの質問ですが、私は誰かがStackOverflowを監視していることを期待していました。

+0

私はこれがCMakeに関連しているとは思わない、それはsphinix自体についてです。あなたはそれについてのチュートリアルを読もうとしましたか? – Joel

+0

はい、私はスフィンクスの使い方を知っています。しかし、私は '' CMakeLists.txt''や他の '' .cmake''ファイルを文書化するために、cmake 3 *の新しいドキュメントシステム*の使い方を知らない。 cmakeのドキュメントシステムは、ユーザーがプロジェクト固有のcmakeファイルを文書化するのではなく、cmakeを文書化するためのものです。 – Phil

答えて

1

引用にもかかわらず、私はCMakeのSphinx関連のコードはユーザーにとって有益だとは思わない。私はあなたのような経験をしましたが、私のプロジェクトのCMakeはCMakeのドキュメントで使用されているSphinxコードとうまく一致しませんでした。

プレーンなスフィンクスを使用して独自のテンプレートを作成するだけです。

+0

私は、cmakeプロジェクトが内部的にさまざまなスフィンクスのディレクティブとロールを持っているので、ユーザーとして何らかの方法があり、ホイールを再開発することなくそれらを利用できることを期待していました。この明確化を私の質問に追加します。 – Phil

+0

@ Phil:もちろん、私はあなたの質問をそのように理解しました。私のプロジェクトでは、これはうまくいかなかった。残念ながら。 – usr1234567

関連する問題