インラインマークアップ前後にスペースを入れたくない¶ Sphinxが使っているreSturucturedTextでは、インラインマークアップの前後にスペースが必要でした。スペースなしでは単語の区切りを認識しないため、インラインマークアップが無視されます。
インラインマークアップ前後にスペースを入れたくない¶ Sphinxが使っているreSturucturedTextでは、インラインマークアップの前後にスペースが必要でした。スペースなしでは単語の区切りを認識しないため、インラインマークアップが無視されます。
Sphinx-users.jp Xアート・オブ・コミュニティー (2011/7/23)¶ Sphinx-users.jpサイトを改善セヨ 日時: 2011/7/23(土) 13:00~18:00 場所: DeNA (新宿) 募集: http://atnd.org/events/17992 (終了しました) 2章を読みます。書籍にある内容をSphinx-users.jpに適用して読み解いていった内容を以下にメモとして残しています。 会の内容¶ コミュニティーの定義¶ なにかの成果を達成することを目的とした集団。Sphinx-users.jpは利用者向けの情報提供を目的としている。 2.2.3 読み手 vs 書き手¶ ここでいう読み手、書き手、はアート・オブ・コミュニティーに書かれている用語で、「コミュニティーが対象とするものを作る人向けの情報」を書き手向け、「ものを利用する人向けの情報」を読
Sphinxで作ったドキュメントのホスティング¶ 日時: 2010/09/05 更新日: 2021/04/04 作者: 渋川よしき、山口能迪、清水川貴之、うさたーん Sphinxでドキュメントを作ったら公開したいですよね?自分のホームページ作成のように、FTPを使って、プロバイダーなどで提供されている所に置くというのも当然できますが、ここではいくつか別の方法を紹介します。 Github Pagesを使ってドキュメントを公開¶ Github Pagesを使えば、個人や組織のウェブサイト、リポジトリのウェブサイトを作ることができます。 必要なもの¶ Githubのアカウント git ケース1: 個人や組織のウェブサイトの公開手順¶ ユーザ名.github.io という名前のリポジトリを作成します(ここのユーザ名は個人のアカウント名、もしくは組織名です)。 SphinxでビルドしたHTML群を登
Sphinx翻訳ハッカソン(2011/2/12)¶ 日時: 2011/2/12 11:00~19:00 場所: オラクル青山センター 13F(東京都港区北青山2-5-8) ソフトウェアのドキュメントに興味のある人が集まって、みんなで翻訳しよう、というイベントです。 なお、翻訳するものは問いませんし、Sphinxを使わなくてもOKです。また、一人でやっても、グループでやってもOK。一人では辛くてすぐ飽きちゃう活動も、みんなと一緒ならがんばれる!というのが目的です。また、翻訳とは関係なく、Sphinxを使ってみたい、という人でも歓迎です。 参加申込みはこちら -> Sphinx + 翻訳 Hack-a-thon 2011.02 : ATND (終了しました) 今回のイベントは25名の方々が翻訳したりSphinx利用の練習をしたりしていました。 PyCon mini JP でSphinxに言及し
Sphinxの標準機能に、LaTeXを経由したPDF出力が入っています。英語の文章であれば簡単に成功しますが、日本語ではスムーズに行かないところもあります。 ここでは日本語ならではの情報を集約します。 Sphinx で利用する TeXディストリビューション¶ Sphinx で日本語文章を書く場合は文字コードに UTF-8が利用されるため、PDF を作成する際には UTF-8 対応版の pLaTeX である必要があります。内部では ebb, mendex, platex, dvipdfmx の各コマンドを利用していますので、これらが利用できる環境を用意します。 ここでは、Windows、OSX、Linux、FreeBSDなどに対応しており、環境の作りやすさを考慮して、TeX Liveというディストリビューションを使って説明をしていきます。
Sphinxクックブック¶ Sphinxクックブックでは、Sphinxの活用方法、Tips集、Sphinx拡張開発に関する話題を取り上げていきます。 もし何かあれば、メーリングリスト、 Twitterで@sphinxjp宛につぶやく などで情報を出してもらえれば、どんどん載せていきます。
SphinxでPDFファイル作成¶ ドキュメントの成果物として、保存したり印刷したりする用途で好まれるのがPDFです。 SphinxではLaTeXを利用したPDF出力が可能です。 本ドキュメントは日本語で出力する場合についての手順を紹介します。 Sphinx で利用する TeXディストリビューション¶ Sphinx で日本語文章を書く場合は文字コードに UTF-8が利用されるため、PDF を作成する際には UTF-8 対応版の pLaTeX である必要があります。内部では ebb, mendex, platex, dvipdfmx の各コマンドを利用していますので、これらが利用できる環境を用意します。 ここでは、Windows、macOS、Linux、FreeBSDなどに対応しており、環境の作りやすさを考慮して、 TeX Live というディストリビューションを使って説明をしていきます。
A project Download 現在のバージョン: 1.4.4 Python Package Indexからソースコードをダウロードするか、以下のコマンドでインストールしてください: pip install -U Sphinx 疑問? 意見? Googleグループのsphinx-users グループへの参加 もしくは、FreeNodeの#sphinx-docチャンネルへどうぞ。 何か気づいたことがあれば、issue trackerを使用して報告することもできます。 Sphinxは知的で美しいドキュメントを簡単に作れるようにするツールです。Georg Brandlによって開発され、BSDライセンスのもとで公開されています。 このツールはもともと、新しいPythonのドキュメントの変換のために作られました。Pythonのプロジェクトのためのすばらしい機能を提供してきましたが、現在ではC/
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を使用している日本語サイト一覧です。Sphinxでは、サイドバーの「ソースコードを表示」でreSTのソースを見ることができます。これらのサイトを見て、気になるテクニックがあればソースコードを見て学ぶことができるでしょう。 デフォルトテーマ¶ TortoiseHg マニュアル: http://tortoisehg.readthedocs.io/ja/latest/ Zope 2 関連ドキュメントと記事: http://zope.jp/zope2/ PyCASL2 & PyCOMET2 ドキュメント: http://www.image.med.osaka-u.ac.jp/member/nakamoto/pycasl2/index.html Quick Sequence Daigram Editor ドキュメント: http://www.shibu
警告 この記事は古い為 easy_install の使用等、現在では非推奨の説明があります。インストール周りについては Windowsへのインストールの手順を参照してください。 日時: 2010/05/21 作者: 渋川よしき 最終更新: 2021/02/12 Sphinxの1.0からは、ePubファイルのビルドができるようになります。ePubファイルというのは、iPadやソニーの電子ブックリーダーなどで利用できる、電子ブックのフォーマットです。原理的にはHTMLに、決まった形式のメタデータを含むファイルを追加して、zipで固めて拡張しをepubにしたものですが、Sphinxを使えば簡単に出力することができます。
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の
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く