のpython-スフィンクスautomoduleとは、私は次のように、ドキュメント文字列からドキュメントを生成するためにautomoduleとを使用してもサードパーティのモジュールからメソッド

ためのドキュメントを生成する：のpython-スフィンクスautomoduleとは、私は次のように、ドキュメント文字列からドキュメントを生成するためにautomoduleとを使用してもサードパーティのモジュールからメソッド

.. automodule:: cdbus.csdb.chemnavi.db.schema 
    :members:

しかしSQLAlchemyのため:members:それはまた、生成されるドキュメントと例コードを使用して、これは私のモジュールではありません。私はモジュールを書くためにsqlalchemyをインポートしました。

Screenshot of documentation

そして、このドキュメントでは、私がmembersキーワードを使用するたびに繰り返されます。 sqlalchemyからこれらの追加の文書や例を削除するにはどうすればよいですか？

出典

2017-07-06 Hitesh Patel

私たちは何が起こっているのかを説明するために「cdbus」についての詳細を知っておく必要があると思います。あなたのコードは何をしていますか？ SQLAlchemyとの関係はどんなものですか？どのように問題を再現できますか？ – mzjn

パッケージとファイルが大きすぎるため、モジュールのインポート方法について説明しています。 cdbusは化学データベースを作成し、sqlalchemyを使用するために書いているモジュールです。 cdbusでbase.pyファイルには、ライブラリ、次のMySQLのDBS、輸入への接続を定義していますsqlalchemy.typesからがsqlalchemy.ext.declarativeインポートからBLOB としてBLOBをインポートNOT_ARCHIVEDの、SQLAlchemyの輸入and_からを、or_ ＃をdeclarative_baseすべての輸入は、AR enot shown このモジュールでは、cdbus/csdb/chemnavi/db/schema.pyにスキーマファイルがあり、これはmysqlスキーマを定義しています。それはcdbus.baseをインポートします –

まだ十分な情報がありません。どのように問題を再現できますか？自分でドキュメントストリングを書いていましたか？それらは出力に現れますか？スクリーンショットでは、表示されているすべてのドキュメントはSQLAlchemyに基づいています。追加する詳細がある場合は、コメントを追加する代わりに質問を編集して提供してください。 – mzjn

automoduleはオプションexclude-membersがあります

.. automodule:: cdbus.csdb.chemnavi.db.schema 
    :members: 
    :exclude-members: this, that, other

出典

2017-07-06 19:43:02

だから、ドキュメントを生成した後は、どの追加のドキュメントが生成されたのかチェックして除外しなければなりません。しかし、インポートされたモジュールからドキュメントを厳密に生成しないオプションはありませんか？ –

のpython-スフィンクスautomoduleとは、私は次のように、ドキュメント文字列からドキュメントを生成するためにautomoduleとを使用してもサードパーティのモジュールからメソッド

答えて

関連する問題