0
dask projectのドキュメントに貢献しようとしています。
pandas
の参考資料をthis issueに記載されているように追加します。
私の開発者マシンでドキュメントを再構築できますが、docstring
を更新すると、ドキュメントに変更が反映されません。
例えば、私はcsv.pyでREAD_DOC_TEMPLATE
を更新する:meth:pandas.{reader}
を追加しようとしているが、何も更新されません。
私はシンプルdocstring
の更新(すなわち、ドキュメンテーション文字列の文言を変更する)何も変更を(私はmake clean
を実行する場合でも)実行しようとしました。スフィンクスでdocstringを更新しています
どのような援助をいただければ幸いです。 @mzjnとして
THX
が、それはあなたがすでにDASKがシステムにインストールされていることだろうとあなたが作業しているクローンではなく、そのバージョンからドキュメントストリングを抽出していることをSphinxが知っていますか? – mzjn
私はdocsのREADMEファイルから示唆されているように、 'conda virtual environment'の中から実行しています。 'docs/source/dataframe-api.rst'ファイルを変更すると、htmlが更新されています。 'READ_DOC_TEMPLATE'を更新しても変更はありません。 –
@mzjnは、docstringを更新するときに、クローンしたコピーまたはインストールされているパッケージのコピーを更新していますか?スフィンクスは後者からドキュメントを作成します。クローンコピーを編集するときは、ローカル編集コピーを再インストールする必要があります。あなたのパッケージの親ディレクトリに 'cd'を実行してから、' 'pip install -e .'にcondaコマンドを実行します(https://pip.pypa.io/en/stable/reference/pip_install/#cmdoption)。 -e)。 –