AWS / PHP / Python ちょいメモ

amazon web service , PHP, Python を使ったときのメモ。日本語でググってもわからなかった事を中心に。

SDKドキュメントにcontributeしようメモ(2)

SDK PHP ドキュメント TIPS sphinx

前回のエントリー で、自分でハードルを上げてましたが、別サービス:SimpleDbを見てみたら、もっとライトで良い気がしてきました。

構造を探ってみる(2): SimpleDbを参考に

SimpleDbのUsersGuideを参考に、構造を探ってみました。

  1. SimpleDbのUsersGuideに該当するrstファイルをエディタで開きます
    • "aws-sdk-php\docs\service-simpledb.rst"
  2. 特殊そうなsphinxのdirectiveのディレクティブタイプを抽出
    • .. service:: S3 しかない (exampleが存在しなかった)
  3. コードについては ".. code-block:: php" で、rstに直接かかれている


SQS, Redshiftについても、SimpleDb同様に code-block で、直接かかれてました。

ということは？(2)

S3の場合は、exampleディレクティブタイプでTestコードを参照されてました。しかし、SimpleDbは、そこまで手が込んでなく、rstに直接コード記載。そうなると前回考察した、”とりあえず版”で十分な気がしてきました。Test書くのは自分の技量ではかなり遠回りなので、とりあえずこの方向性で書いてることにします。

とりあえず版(2)

Testsコードは必須じゃないと考える場合、書くだけなればこれだけでOK。

  1. UsersGuideを書くサービスを選ぶ
  2. 該当するrstファイルを編集
  3. コードサンプルは ".. code-block:: php" で、rstに直接記述