文書化¶
GetFEM ライブラリにはかなりの量のドキュメントがあり，その多くはさまざまな著者によって提供されています． GetFEM ドキュメントに使用されるmarkupは， docutils`_プロジェクトによって開発された reStructuredText`_であり，カスタムディレクティブによって修正され，HTML出力を後処理するために `Sphinx`_という名前のツールセットを使用します．
このドキュメントでは，ドキュメントのスタイルガイド，Pythonドキュメントをサポートするために導入されたカスタムreStructuredTextマークアップとその使用方法，およびSphinxビルドシステムについて説明します．
GetFEM のドキュメントへの貢献に関心がある場合は，それほど気に入らないのであればreStructuredTextを書く必要はありません．プレーンテキストの投稿も歓迎します．主なドキュメントはプロジェクトの ``doc/sphinx/source``ディレクトリにあります．ドキュメントの一部は自動であり，プロジェクトのソースから取得されます．これは特に ``interface/src/gf_*.cc``ファイルにあるインターフェースコマンドのドキュメントの場合です．
作成された各C ++クラスとエクスポートされた関数を，ソース（Oxygenドキュメント用）とユーザードキュメントの両方にドキュメント化することを強くお勧めします．