2017-09-17 6 views
0

dask projectのドキュメントに貢献しようとしています。
pandasの参考資料をthis issueに記載されているように追加します。
私の開発者マシンでドキュメントを再構築できますが、docstringを更新すると、ドキュメントに変更が反映されません。
例えば、私はcsv.pyREAD_DOC_TEMPLATEを更新する:meth:pandas.{reader}を追加しようとしているが、何も更新されません。
私はシンプルdocstringの更新(すなわち、ドキュメンテーション文字列の文言を変更する)何も変更を(私はmake cleanを実行する場合でも)実行しようとしました。スフィンクスでdocstringを更新しています

どのような援助をいただければ幸いです。 @mzjnとして

THX

+0

が、それはあなたがすでにDASKがシステムにインストールされていることだろうとあなたが作業しているクローンではなく、そのバージョンからドキュメントストリングを抽出していることをSphinxが知っていますか? – mzjn

+0

私はdocsのREADMEファイルから示唆されているように、 'conda virtual environment'の中から実行しています。 'docs/source/dataframe-api.rst'ファイルを変更すると、htmlが更新されています。 'READ_DOC_TEMPLATE'を更新しても変更はありません。 –

+0

@mzjnは、docstringを更新するときに、クローンしたコピーまたはインストールされているパッケージのコピーを更新していますか?スフィンクスは後者からドキュメントを作成します。クローンコピーを編集するときは、ローカル編集コピーを再インストールする必要があります。あなたのパッケージの親ディレクトリに 'cd'を実行してから、' 'pip install -e .'にcondaコマンドを実行します(https://pip.pypa.io/en/stable/reference/pip_install/#cmdoption)。 -e)。 –

答えて

0

コメント:
ソリューションは、次の行でconf.py(コメント解除)を更新しました:

sys.path.insert(0, os.path.abspath('../../')) 
関連する問題