このリポジトリでは、 Gehirn Web Services API Documentation を構成するすべてのコンテンツを管理しています。 Gehirn Web Services API Documentation は、ゲヒルン株式会社が運営するGehirn Web Services とその各追加サービスで提供する Web API のご利用方法を説明するドキュメントです。
Gehirn Web Services API Documentation が提供するすべての文書は、 reStructuredText マークアップ言語で記述し、 Python 製のドキュメンテーションツール Sphinx を用いて静的な HTML ファイルにビルドしています。
そのため、 Gehirn Web Services API Documentation をビルドするためには、 Sphinx がインストールされた環境が必要です。
Sphinx は Python Package Index で配布されているため、 Python 標準のパッケージマネージャー pip を用いてインストールすることができます。
pip を用いたインストール方法のコマンド例を以下に示します。
pip install sphinxGehirnInc/gws_api_docs は Sphinx が提供する Makefile を含んでいるため、 Sphinx をインストールした環境にクローンした GehirnInc/gws_api_docs のルートディレクトリへ移動し、以下に示す make コマンドを実行することで、静的な HTML を出力することができます。
make htmlビルドされた HTML はカレントディレクトリの build/html 以下に出力されます。
ドキュメントの内容の正確性には注意を払っていますが、もしドキュメントの不備にお気づきの場合は、以下に示すいずれかの方法で当社までご報告いただけると幸いです。 なお、ご報告いただく際は、ご報告いただく不備が存在するドキュメントが記述されている自然言語を用いてください。 また、すでに同一の不備が Issues と Pull Requests のどちらでも報告されていない事をご確認ください。
ご報告いただいた不備は、当社でその内容を検証したうえで、できるだけ速やかに修正させていただきます。
発見いただいた不備を説明する新しい Issue を GehirnInc/gws_api_docs の Issues から作成してください。 作成いただく Issue には以下の情報を含むようにしてください。
- 当該不備が存在する Gehirn Web Services API Documentation の URL
- 当該不備のご説明
- どのように修正されるべきか（任意）
- お客様の Gehirn ID （ Gehirn ID Center に開設されている場合)
発見いただいた不備をお客様によって修正していただいたうえで、 GehirnInc/gws_api_docs の master ブランチに対する Pull Request を作成してください。
なお、お客様がすでに Gehirn ID Center に Gehirn ID を開設されている場合は、当該 Gehirn ID を Pull Request と併せてご連絡ください。
- このドキュメントでカバーする内容は Gehirn Web Services とその各追加サービスで提供する Web API のご利用方法に限ります。
- サービスの機能や価格などについては、 Gehirn Web Services サービスサイト をご参照ください。
- コントロールパネルのご利用方法については、 Gehirn Support Center をご参照ください。
- Issues 及び Pull Requests でご報告いただける内容は Gehirn Web Services API Documentation に存在する不備に限ります。
- お客様がご利用中の環境で発生している問題については、 Gehirn Support Center 内の お問い合わせ フォームから当社までご連絡ください。
- Issues 及び Pull Requests はインターネットで広く公開されている事にご留意いただき、コンフィデンシャルな情報を含まないようにしてください。