Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                

タグ

Sphinxに関するtoshiyukinoのブックマーク (3)

  • Jupyter Notebookを単体テストやマニュアル作成ツールとして使う - Qiita

    マニュアルの機能一覧を意訳してみました。 'test*.ipynb'ファイルをディスカバリします Notebookの各セルが単体テストとして実行されます(assertを使うだけ) 各セルの最初の行のコメント(docstring)は、テスト名または関数名として扱われます。 docstringに'fixture*'または'setup*'とすれば、それぞれの単体テストの前に実行されます docstringに'SKIPCI'と書けばTravis-CIでのテストはスキップされます(CI環境変数が定義されているかどうかを確認) IPython Notebookカーネルはテスト後にリスタートされます テスト時のワーキングフォルダは、.ipynbファイルのローカルです 訳に間違いがありましたら、ご指摘をお願いします。 あとは普通にpy.test -vを実行するだけで、Notebookも含んだテストをしてく

    Jupyter Notebookを単体テストやマニュアル作成ツールとして使う - Qiita
  • Read the Docs & Sphinx now support Commonmark

    from recommonmark.parser import CommonMarkParser source_parsers = {'.md': CommonMarkParser} source_suffix = ['.rst', '.md'] This allows you to write both .md and .rst files inside of the same project. Example Project¶ You can see this in action in my sphinx-markdown-test repo on GitHub. You can also see a rendered version hosted on Read the Docs. How it works¶ The way this project works is that it

    Read the Docs & Sphinx now support Commonmark
  • reSTおよびSphinxで文章を書く際のtips - そこはかとなく書くよ。

    Sphinxを使って論文っぽい文章を書くときのtipsをまとめておきます。 追記: この内容は Sphinx逆引き辞典により詳細にして載っています。 用語を書く際はreplaceを使う .. |hoge| replace:: ほげらこう定義しておくと次からは |hoge| とするだけで、ほげらと自動的に展開してくれます。つまり、あとからこの用語名を変えたいな、と思ったときにはこの定義のところだけを変えれば勝手に全部入れ替えてくれる、というわけです。 ただし、複数のrstファイルに分けている場合には使えないので、別のファイル(例えばdefinition.txt)に replace を書いておき、 .. include:: definition.txtと各rstファイルの先頭に書いておきます。この時、.rstではなく.txtなど他の拡張子のファイルに書いていることに注意してください。そうしない

    reSTおよびSphinxで文章を書く際のtips - そこはかとなく書くよ。
  • 1