https://www.freia.jp/taka/blog/sphinx-i18n-translation-procedure-with-transifex-amazon-s3/index.html
Pocoo
Pocoo was a loosely assembled team of Open Source developers working on some very popular Python projects. Out of this came the Pygments syntax highlighter, the Sphinx documentation system, the Flask web framework, the Jinja templating engine, the Werkzeug WSGI library, the Click command line toolkit and much more. It was led by Armin Ronacher and Georg Brandl. As projects get more mature more str
Full featured documentation deployment platform
Documentation simplified Build, host, and share documentation, all with a single platform. Sign up now Easy previews and deploys Preview changes on every commit to your pull requests. Release documentation to your users on each merge. Ideal developer experience Write documentation without changing your workflow or your tools using a docs as code approach. Work privately or publicly Easily share wi
2012.05版 Python開発のお気に入り構成（ポロリもあるよ） - YAMAGUCHI::weblog
はじめに こんにちは、Python界の情弱です。最近は色々とPythonの開発環境も変化してきていて、ようやくPython2.xとPython3.xを行き来しながら開発する体制が整ってきたという印象を受けています。ここしばらくは色々と試していたのですが、ようやく鉄板っぽい方法にたどり着いたのでメモしておきます。 なお、後半はPythonに限らない内容なので、他のLLを使っていても使えそうかなと思っています。この環境を設定すると何ができるのかというと、以下のことすべてが、無料で、自鯖を立てることなく行えます。 開発環境の整理（virtualenv） ローカルでの複数環境のテスト容易化（tox+pytest） CIによるテスト（Travis-CI） ドキュメントの自動ビルドおよびドキュメントの公開（ReadTheDocs） 概要 とりあえず全体像を先に共有しておきます。ちょっとでかいですがご了
Sphinxのi18nを実際に試してみた - そこはかとなく書くよ。
2011年1月29日に行われた、PyConMini JPにて、IanさんがSphinxのi18n機能の紹介をしてくださいました。(http://www.slideshare.net/IanMLewis/sphinx-11-i18n) というわけで、実際に試してみました。まずは英語->日本語をやってみます。 なお、環境は sphinx-1.1pre GNU gettext-tools 0.18.1 FreeBSD-8.1R で行いました。LinuxなどではLOCALEの扱いが違うかもしれませんが、おそらく同じです。 1. buildで.potファイルを作成 % make gettext # build/locale/index.pot ができる 2. poファイルを作る % cd build/locale/ % msginit --locale=ja --input=index.pot #
ブロック図生成ツール blockdiag — blockdiag 1.0 ドキュメント
ブロック図生成ツール blockdiag¶ blockdiag シリーズはシンプルなテキストからブロック図などの画像を生成する画像生成ツール群です。 blockdiag を用いると以下のような図が簡単に生成できます。 blockdiag の主な機能: 数種類の図に対応 ブロック図 (blockdiag コマンド) シーケンス図 (seqdiag コマンド) アクティビティ図 (actdiag コマンド) 論理ネットワーク図 (nwdiag コマンド) テキストベースの定義ファイルから画像ファイルを生成 (graphviz 風の文法を採用) 定義にあわせて図の配置を自動的に決定 (自動レイアウト) Sphinx, Trac, Redmine, 各種 Wiki エンジン等、多様なシステムへの画像埋め込みに対応 Enjoy documentation with blockdiag !
Sphinxで作ったドキュメントのホスティング
Sphinxで作ったドキュメントのホスティング¶ 日時: 2010/09/05 更新日: 2021/04/04 作者: 渋川よしき、山口能迪、清水川貴之、うさたーん Sphinxでドキュメントを作ったら公開したいですよね？自分のホームページ作成のように、FTPを使って、プロバイダーなどで提供されている所に置くというのも当然できますが、ここではいくつか別の方法を紹介します。 Github Pagesを使ってドキュメントを公開¶ Github Pagesを使えば、個人や組織のウェブサイト、リポジトリのウェブサイトを作ることができます。 必要なもの¶ Githubのアカウント git ケース1: 個人や組織のウェブサイトの公開手順¶ ユーザ名.github.io という名前のリポジトリを作成します(ここのユーザ名は個人のアカウント名、もしくは組織名です)。 SphinxでビルドしたHTML群を登
Sphinx-Users.jp :: ドキュメンテーションツール スフィンクス Sphinx-users.jp
Sphinx-Users.jp¶ Sphinx-Users.jp(略称#sphinxjp)は、美しいドキュメントを簡単に生成することができるドキュメンテーションツール、 Sphinx （スフィンクス）の普及を主眼としたコミュニティです。SphinxはPythonの公式ドキュメントだけでなく、このSphinx-Users.jpのサイトも含め多くのマニュアルやサイトで使用されており、詳細を Sphinxの歴史で紹介しています。 Sphinx-Users.jp は日本の Sphinx コミュニティです。 Sphinx-Users.jp では、日本で散らばっているSphinx関連情報を集めて、Webサイト、イベントを通じてSphinx情報を発信します。 slack のコミュニケーションや勉強会の開催などを通じて、ドキュメントをパワーアップしたい人、ドキュメントや翻訳で苦労している人、Sphinxの
Sphinx逆引き辞典 — Sphinx逆引き辞典 (ver. 2011-06-17)
ナビゲーション 索引 次へ | Sphinx逆引き辞典 (ver. 2011-06-17) » Sphinx逆引辞典は、sphinx-users.jpに移転しました 移転先 bitbucketレポジトリ¶ レポジトリ Issueリスト 目次 Sphinx逆引き辞典 bitbucketレポジトリ todoリスト Indices and tables 次のトピックへ reST/Sphinxを使うときの最初の一歩 このページ ソースコードを表示 クイック検索 モジュール、クラス、または関数名を入力してください ナビゲーション 索引 次へ | Sphinx逆引き辞典 (ver. 2011-06-17) » © Copyright 2011, shirou(r_rudi). このドキュメントは Sphinx 1.0.7 で生成しました。
reStructuredText入門 — Sphinx v1.0 (hg) documentation
reStructuredText入門¶ このセクションは、reStructuredText(reST)の考え方や文法についての短いイントロダクションです。Sphinxユーザがドキュメントを作成するために十分な情報を提供します。reSTはシンプルに設計された、控えめなマークアップ言語ですので、理解するのにそれほど時間はかからないでしょう。 段落(パラグラフ)¶ 段落はreSTドキュメントにおける、もっとも基本的な要素です。段落は1行以上の空行で区切られた、シンプルなテキストの固まりです。 Pythonにおいてインデントが重要な意味を持つのと同様、reSTでもインデントは重要です。同じ段落のすべての行は、インデントを同じ高さにそろえて、左揃えにしなければなりません。 インラインマークアップ¶ 標準のreSTインラインマークアップは極めてシンプルです。 アスタリスク1つ: *テキスト* 強調(
Django ドキュメントの仕組み — Django v1.1 documentation
... と、ドキュメント作業への貢献方法 Django のドキュメントは Sphinx ドキュメンテーションシステムを使っています。 Sphinx は docutils に基づいて作られています。 docutils は、簡単な書式の プレーンテキストを、 HTML や PDF その他の様々な出力形式で簡単に扱えるように することを念頭に置いて作られています。 ドキュメントを実際に手元でビルドするには、現状では Sphinx をインストールす る必要があります。インストールは easy_install Sphinx でできます。 さて、 html のビルドは簡単です。単に docs ディレクトリで make html を実行するだけです。 ドキュメント作業に貢献したいなら、まず ReStructuredText Primer を読みま しょう。その後 Sphinx 固有のマークアップ の説明
Sphinxでmscgen / graphviz | Go for it!
Sphinxでドキュメントを書いたりしています。 以前からシーケンス図やブロック図を描くのに それぞれ mscgen や graphviz といったツールを使っています。 これらのソフトウェアは、テキスト形式で定義を記述する（dot形式というらしい）と画像を生成してくれます。 単純に画像を作るだけならMicrosoft VisioやOmniGraffleでいいのですが、 テキストベースでドキュメントを書いている場合、いろんなアプリケーションを 横断しなくてはならず、ちょっと面倒なんですよね。 mscgenやgraphvizを使えばテキストファイルのみで管理することができるというわけです。 で、本題。 Sphinxにはこれらの拡張が用意されています（標準ではないです）。 拡張を導入することでSphinxドキュメント内にdot記述をすることが出来るようになります。 http://package
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Tinkererをカスタマイズする — An Artisan's Build Act
https://tinkerer.me/
カスタムのインラインマークアップを定義する方法
oceanmarine.org
SphinxでドキュメンテーションコメントをHTMLに変換する方法 - With-No-Parachute D-side
https://sphinx-users.jp/cookbook/hosting/