Shapely: 自動ドキュメントビルド

作成日 2015年10月27日  ·  6コメント  ·  ソース: Toblerity/Shapely

Travisのデプロイシステムを使用して、ドキュメントのビルドと公開のワークフローを自動化します。

#336も参照してください。

documentation enhancement

最も参考になるコメント

また、travisルートのドキュメントを参照する場合は、 https://github.com/drdoctr/doctrの認知度を高めたいと考えています。

全てのコメント6件

ちなみに、matplotlibはすでにこれを行っています。 https://github.com/matplotlib/matplotlib/blob/master/.travis.yml#L126を参照してください

私は間違いなくプロセスを改善できると思います...

さらに、ReadTheDocsがcondaのインストールを実行できるようになり、RTDがShapelyドキュメント構築の実行可能なオプションになっていることを知りました(Cartopyの概念実証を成功させました)。

私はこれに挑戦し、このチュートリアルに基づいて何かが機能しています: https ://gist.github.com/domenic/ec8b0fc8ab45f39403dd

変更はここにあります: https ://github.com/Toblerity/Shapely/compare/master ... snorfalorpagus:autodoc

このプロセスでは、新しいSSHキーペアを作成し、暗号化されたバージョンの秘密キーをリポジトリ/ Travisに配置する必要があります。

1つのインスタンス(スピードアップを備えたPython 3.5)でのみドキュメントをビルドするように設定されています。 https://travis-ci.org/snorfalorpagus/Shapely/jobs/177188968

これは、ドキュメントで図を作成するスクリプトのかなりの数がPython 3.xと互換性がないことを強調しています。たとえば、buffer.pyは次のようになります。

Traceback (most recent call last):
  File "buffer.py", line 29, in <module>
    ax.set_xticks(range(*xrange) + [xrange[-1]])
TypeError: unsupported operand type(s) for +: 'range' and 'list'

@snorfalorpagusこれにもっと時間を費やす前に、manylinux1ホイールがreadthedocsをより良いオプションにするのに役立つかどうかを調べてみましょう。

また、travisルートのドキュメントを参照する場合は、 https://github.com/drdoctr/doctrの認知度を高めたいと考えています。

これを次のマイルストーンに移します。 1.6.0のブロックを解除して、後でドキュメントの作業をしたいと思います。

このページは役に立ちましたか?
0 / 5 - 0 評価