タグ

関連タグで絞り込む (0)

  • 関連タグはありません

タグの絞り込みを解除

PythonとdocumentationとSphinxに関するraimon49のブックマーク (6)

  • Pythonのdocstring(ドキュメンテーション文字列)の書き方 | note.nkmk.me

    Pythonでは、関数やクラスなどの定義の先頭に記述された文字列が、docstring(ドックストリング、ドキュメンテーション文字列)として扱われる。 IDEやエディタによってはキーボードショートカットでdocstringを表示させて内容を確認できる。またPyCharmなどでは、docstringの情報をもとに静的解析して警告を出してくれる。

    Pythonのdocstring(ドキュメンテーション文字列)の書き方 | note.nkmk.me
    raimon49
    raimon49 2019/03/24
    引数や返り値のスタイル分類。他にはJavadocみたいに書く人も居る。
  • ドキュメントの継続的な開発方法 | IIJ Engineers Blog

    私はソフトウェア開発を主体とするエンジニアで、 クラウドサービスの開発・運用 分散処理技術の検証とサービス利用の検討 社内の開発支援環境の開発・運用 などの業務に従事していますが、今回の記事は業務とは直接的な関係は無く、私が会社で勝手自発的に行っている取り組みについて書きたいと思います。 昨今、インターネットは生活に深く浸透し、クラウドサービスを利用することで安く簡単にWebサービスを開発、公開できるようになりました。Web技術の進化や流行の移り変りも非常に激しく、既存サービスの機能追加や新規サービスの開発は頻繁に行われています。それは弊社も例外ではありません。 このような開発の現場では、リーンソフトウェア開発への取り組みなど開発手法の最適化が積極的に行われ、様々なベストプラクティスが生みだされています。それらのベストプラクティスには、 継続的インテグレーション や 継続的デプロイメント

    ドキュメントの継続的な開発方法 | IIJ Engineers Blog
    raimon49
    raimon49 2016/06/01
    pipとnpmのハイブリッドになっちゃうのがなぁ。
  • PyCon JP 2015 keynote

    Oct 11, 2015Download as pptx, pdf20 likes18,273 views

    PyCon JP 2015 keynote
  • 国際化 — Sphinx 1.4.4 ドキュメント

    Sphinxでは、ナビゲーションバーなどの文字列を各国語にする機能を提供していましたが、 文章 そのものを翻訳する機能を提供します。細かい設定については 国際化のオプション を参照してください。 Sphinx 国際化について¶ gettext [1] は国際化とローカル化の手段として、よく使用されている方法です。プログラム中で使用されるメッセージと、翻訳文字列の対応表を使って置き換えてきます。Sphinxはこの機能を使って、ドキュメント全体を翻訳していきます。 まず最初に、プロジェクトのメンテナーはすべての翻訳文字列を集めてくる必要があります(これを メッセージ と呼ぶ)。これを翻訳者に渡します。Sphinxでは、 sphinx-build -b gettext を実行して、これを行います。 すべてdoctreeの要素は、それぞれがメッセージとなります。巨大なパラグラフは原文のまま残ります

    raimon49
    raimon49 2015/08/09
    .potファイル、.poファイル、.moファイル
  • 2012.05版 Python開発のお気に入り構成(ポロリもあるよ) - YAMAGUCHI::weblog

    はじめに こんにちは、Python界の情弱です。最近は色々とPythonの開発環境も変化してきていて、ようやくPython2.xとPython3.xを行き来しながら開発する体制が整ってきたという印象を受けています。ここしばらくは色々と試していたのですが、ようやく鉄板っぽい方法にたどり着いたのでメモしておきます。 なお、後半はPythonに限らない内容なので、他のLLを使っていても使えそうかなと思っています。この環境を設定すると何ができるのかというと、以下のことすべてが、無料で、自鯖を立てることなく行えます。 開発環境の整理(virtualenv) ローカルでの複数環境のテスト容易化(tox+pytest) CIによるテスト(Travis-CI) ドキュメントの自動ビルドおよびドキュメントの公開(ReadTheDocs) 概要 とりあえず全体像を先に共有しておきます。ちょっとでかいですがご了

    2012.05版 Python開発のお気に入り構成(ポロリもあるよ) - YAMAGUCHI::weblog
    raimon49
    raimon49 2012/07/15
    ローカルテスト環境のマルチバージョンPythonからリモートのCI環境、ドキュメントホスティングまで。
  • Shibu's Diary: Sphinxへの感謝の気持ちをブログに書いてみる

    渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 僕はSphinx-Users.jpの創設者です。そんでもって、Sphinx-Users.jpの会長をやっていました。先月、次の代表に譲ったので今は違います。現在の会長は@tk0miyaさんです。通称、世界の小宮。副会長は前期からの引き続いて@shimizukawaさんと、新規の@shkumagaiさんです。できる人ほど忙しい、という法則の通り、みんな暇ではないのですが、きちんとビジョンを持った、良いメンバーだと思います。 僕が代表を辞した理由は、転勤によるものです。今はベイスターズで有名な東京のDeNAで働いています。実は野球以外にソーシャルゲームをやっている会社でして、僕もそちらの仕事をしています。来月から、アメリカの子会社のngmoco:)に転勤になります。サンフランシスコ

  • 1