APIの調査をする際、freecadweb.orgに接続するのも良いですが、ドキュメントの更新が遅れていたり、GitHubのXMLをわざわざ見に行くのは、正直少々面倒です。
今回はWebを介さず、ローカルインストールしたFreeCADからAPIドキュメントを閲覧する方法を紹介します。
1. 環境
- FreeCAD 0.18
今回はプログラムを打ちませんので、気楽に見て頂ければと思います。
2. ローカルのAPIドキュメントを閲覧する方法
実は手順はすごく簡単です。
FreeCADを起動し、メニューの[ヘルプ - Pythonモジュールのマニュアル]をクリックしてください。
すると、ブラウザ経由でFreeCADがインストールされたローカルフォルダの構成が表示されます。
表示されたら、下図のリンクを探しましょう。
試しにFreeCADのリンクを押下してみましょう。すると、FreeCADライブラリの中身が画面に表示されます。
あとはブラウザの検索機能を使って、単語の検索をすれば終了です。
3. まとめ
- APIドキュメントは、Webを見なくても閲覧する方法がある
4. 最後に
APIドキュメントが見えるのは良いのですが、引数の説明が少々上級者向けで噛み砕くのに苦労しますね。
更なる情報をお探しの方は！
下記のリンクから、FreeCADプログラミングのトップページに飛びます。
よろしければご参照くださいませ。
