config.pyで設定ができます。 todayこの値が空でなければ、この値で置換されます。 today_fmt日付の形式を指定します。標準では '%B %d, %Y' です。 なお、languageが指定されて、かつ、そのlanguageで日付の形式が指定されている場合は、その形式が標準となります。 適用例¶ これをビルドした日は 2024年05月16日です。
今日の日付を埋め込みたい
config.pyで設定ができます。 todayこの値が空でなければ、この値で置換されます。 today_fmt日付の形式を指定します。標準では '%B %d, %Y' です。 なお、languageが指定されて、かつ、そのlanguageで日付の形式が指定されている場合は、その形式が標準となります。 適用例¶ これをビルドした日は 2024年05月16日です。
さくらインターネットで自動ビルド
さくらインターネットで自動ビルド¶ 日時: 2012/1/25 作者: 渋川よしき Sphinx-Users.jpで2008年ぐらいから使っている方法を紹介します。常駐のできない、一番安価なさくらのスタンダードプランとBitbucketを使う方法です。 この方法には以下のようなメリットがあります。 サーバのパスワードを公開することなく、複数人でコンテンツの管理を行うことができる BitbucketのウェブUIを使って、権限設定などを簡単に行うことができる ウェブのコンテンツをすべてバージョン管理で制御できる 自前のテンプレートや特別な拡張機能がいくらでも使える 問題の報告や管理に、Bitbucketのチケットのシステムが利用できる パッチの受け取りに、pull-requestを使うこともできる リポジトリの準備¶ http://bitbucket.org のサイトにアクセスし、リポジトリを
Sphinxをはじめよう
Sphinxをはじめよう¶ Sphinxを使って、かんたんな書籍紹介のドキュメントを作っていきます。 Sphinxのインストール¶ SphinxはPythonで書かれているため、Sphinxのインストールにあたっては、Pythonのセットアップと、Sphinxのインストールの両方が必要になります。 プロジェクトの作成¶ Sphinxでドキュメントを作るには、まずはドキュメントのプロジェクトを作ります。 Ruby on Rails のScaffoldや、 Django のプロジェクトと似ていて、コマンドラインから、いくつかの質問に答えるとできあがります。 このひな形の作成と、ドキュメントのツリー構造の説明を行っていきます。
SphinxでかんたんePubファイル作成
警告 この記事は古い為 easy_install の使用等、現在では非推奨の説明があります。インストール周りについては Windowsへのインストールの手順を参照してください。 日時: 2010/05/21 作者: 渋川よしき 最終更新: 2021/02/12 Sphinxの1.0からは、ePubファイルのビルドができるようになります。ePubファイルというのは、iPadやソニーの電子ブックリーダーなどで利用できる、電子ブックのフォーマットです。原理的にはHTMLに、決まった形式のメタデータを含むファイルを追加して、zipで固めて拡張しをepubにしたものですが、Sphinxを使えば簡単に出力することができます。
Sphinxクックブック
Sphinxクックブック¶ Sphinxクックブックでは、Sphinxの活用方法、Tips集、Sphinx拡張開発に関する話題を取り上げていきます。 もし何かあれば、メーリングリスト、 Twitterで@sphinxjp宛につぶやく などで情報を出してもらえれば、どんどん載せていきます。
sphinx-quickstartの詳細説明
sphinx-quickstartの詳細説明¶ Enterで飛ばした質問では主に何を回答しているのかというと、フォルダの配置をどうするか、プラグインを追加するか、などです。ここで入力した内容は、 conf.py というファイルに書き込まれますので、必要に応じていつでも変更がかけられます。少し長いですが、聞かれる内容について軽く紹介します。もちろん、上記3つ以外はデフォルトで問題ありませんので、先が知りたい方は次のセクションに進んでしまっても大丈夫です $ sphinx-quickstart Welcome to the Sphinx quickstart utility. Please enter values for the following settings (just press Enter to accept a default value, if one is given in
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の
Overview — Sphinx v1.0.6 documentation
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のドキュメントサンプル：業務利用例
Sphinxのドキュメントサンプル：業務利用例¶ 日本UNIXユーザ会 2010年12月勉強会 (2010/12/3) の発表で使用したドキュメントを作りたくなってしまう魔法のツール Sphinx のデモで使用したドキュメントのひな形です。プレゼンテーションの全文はドキュメントを作りたくなってしまう魔法のツール Sphinx にあります。 デモで使用したSphinxのドキュメントサンプルを以下のリンクからダウンロード出来ます。 Step2:ドキュメントの例(Sphinxデータ) 2portfolio.zip Step2:ドキュメントの例(HTML) Step1 Sphinxの初期ドキュメントから始める¶ 初期ドキュメントから始めると言っても、 sphinx-quickstart コマンドで作成しただけの状態のファイルを共有しても、それではドキュメントを書いてくれないでしょう。これは「どう書
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
https://sphinx-users.jp/doc11/contents.html
逆引き辞典
rst2pdf拡張を使ったPDFファイル作成 — Python製ドキュメンテーションビルダー、Sphinxの日本ユーザ会