タグ

pythonとsphinxに関するMukeのブックマーク (2)

  • Pythonをやるときに参考になりそうな情報 - のんびりSEの議事録

    最近あんまり触っていなかったので、久々にPythonをやろうと思ったときにいろいろ忘れてたり、新しく知ったりしたこともあったので、Pythonやるときに参考になりそうな情報をまとめました (但し、今回はデータ分析系のライブラリ関連は除いています) Pythonの言語仕様や基等 概要 — Python 3.5.2 ドキュメントdocs.python.jp qiita.com www.python-izm.com 2系と3系の違い postd.cc qiita.com コーディング規約 はじめに — pep8-ja 1.0 ドキュメント ドキュメント生成 azunobu.hatenablog.com ドックストリング """ 3重ダブルクォートを使用して記載する。 ドックストリングに記述したテキストは関数やクラスオブジェクトの__doc__に保存される def hello(): """Out

    Pythonをやるときに参考になりそうな情報 - のんびりSEの議事録
  • reStructuredText入門 — Sphinx v1.0 (hg) documentation

    reStructuredText入門¶ このセクションは、reStructuredText(reST)の考え方や文法についての短いイントロダクションです。Sphinxユーザがドキュメントを作成するために十分な情報を提供します。reSTはシンプルに設計された、控えめなマークアップ言語ですので、理解するのにそれほど時間はかからないでしょう。 段落(パラグラフ)¶ 段落はreSTドキュメントにおける、もっとも基的な要素です。段落は1行以上の空行で区切られた、シンプルなテキストの固まりです。 Pythonにおいてインデントが重要な意味を持つのと同様、reSTでもインデントは重要です。同じ段落のすべての行は、インデントを同じ高さにそろえて、左揃えにしなければなりません。 インラインマークアップ¶ 標準のreSTインラインマークアップは極めてシンプルです。 アスタリスク1つ: *テキスト* 強調(

  • 1