MinenoLab / PiNode3

https://minenolab.github.io/PiNode3/
0 stars 0 forks source link

Sphinxでprivateメソッドのドキュメントも作成する方法を調べる #17

Closed ShimadaTakutoLuke closed 2 months ago

ShimadaTakutoLuke commented 2 months ago

usbモジュールのアンダースコアーがついたメソッドのマニュアルが表示できない

ソースコード

 def _get_connect_ports(self):
        """
        接続されているデバイスのUSBポート番号を配列として取得

        Returns:
        usb_ports: USB接続している機器のポート番号

        Details:
        配列内の各値は以下の意味を持つ.
        # 1 -> 左上
        # 2 -> 左下
        # 3 -> 右上
        # 4 -> 右下
        """
        usb_ports = []
        devices = os.listdir('/dev/')
        for device in devices:
            if 'ttyUSB_' in device:
                usb_ports.append(int(device[-1]))
        return usb_ports

ホームページ画面 image

ShimadaTakutoLuke commented 2 months ago

参考リンク https://qiita.com/kioto/items/6f8ca6a637bd66d21a34

MinenoLab commented 2 months ago

20 で解決したのでクローズします!