いくつかの記事で紹介されているとおり、 recommonmark を使うと Sphinx で markdown を使うことができます。 Software Design 2016年4月号 Markdownで始めるSphinx MarkdownでSphinxできるようになったので試してみた(前編) - 意識の高いLISPマシン Markdownで書けるSphinxの構築 - Qiita しかし、recommonmark を利用しても、ドキュメント構造(toctree)を記述するためには部分的に reStructredText を使う必要がありました。 .. toctree chapter1 chapter2 chapter3 これは、文法を拡張する仕組みを持たない markdown の (commonmark の)構造上、仕方がないのですが、せっかく markdown でドキュメントを書いてい
WEB+DB PRESS vol88にMQTTの記事を書きました¶ 2015年8月22日発売の WEB+DB PRESS vol88 に 速習 MQTT というタイトルでMQTTに関する記事を書かせていただきました。 内容は以下の通りです。 MQTTとは MQTTの利用場面 MQTTの特長 その他のプロトコルとの比較 MQTTを使ってみる 速習、というタイトルの通り、利用場面や特長の説明がメインの、MQTTという聞きなれないプロトコルの内容を一通り説明する内容になっています。一応MQTTを使ってみる、という箇所でMQTTを使うアプリをpythonで実装してみていますが、 eclipse paho のおかげもあり、非常に短い行で実装が完了しており、分量は正直あんまりです。 最近すっかりバズワード化してしまい、「MQTTはIoT時代の主役となるプロトコルだ」「MQTTで全部できる」というような
Hello and welcome to the Sphinxit documentation. I recommend you to get started with Installation and then head over to the Usage tutorial. Sphinxit is light and powerful SphinxQL query constructor, thin integration layer between your Python application and Sphinx search engine. Sphinxit is framework-free library, you can use it anywhere you need powerful Sphinx-based search. Forget about deprecat
システムやアプリ開発に取り組むプログラマーの多くが苦手としているのが「ドキュメント作成」。IT業界ではいまだにWordやExcelがメジャーなドキュメントツールとして用いられているが、そもそもこれらのソフトを敬遠している人も少なくないのではないだろうか。 とはいえ、組織としてコーディングを手掛けている限り、ドキュメント作成は避けて通れない“義務”であることも事実。そこで今、面倒なドキュメント作成をよりプログラマブルに行えるツールとしてPythonistaの脚光を集めているのが、OSSのドキュメンテーションビルダー『Sphinx』だ。 『Sphinx』は、Python 3.2や3.3のリリースマネジャーとして知られるゲオルグ・ブランドル氏が開発し、BSDライセンスを通じて公開されたツール。マークアップ言語のreStructuredTextでドキュメントを書いておけば、HTMLやPDF(拡張機
hiramininfo.png Tweaks.rst Sphinx と LaTeX を使うときの 小技 著者:打田 旭宏 ライセンス:CC-BY 3.0 更新日時:Mon Mar 9 18:22:51 UTC 2026 Sphinx の LaTeX 出力を利用するときに見栄えを凝るのに知っておくとよいかもしれない小技をまとめました。 目次 前置き - LaTeX について少しだけ - できるだけモノクロにする レイアウト変更 目次を出力しない 索引を出力しない コードブロックに枠線をつける ヘッダ・フッタに手を加える 章見出しに手を加える フォント 欧文フォントを変更 和文多書体を利用する おまけ 最後に - 雑感 - 前置き - LaTeX について少しだけ - 以下では プリアンブル (preamble) という LaTeX 用語がよくでてきます。 preamble は序文や前置きとい
This will also install Sphinx, feedgen, and Invoke respectively required for building your website, making it look good, generating feeds, and running deploy commands. Getting Started¶ If you are starting a new project, see the ABlog Quick Start guide. If you already have a project, enable blogging by making following changes in conf.py: # 1. Add 'ablog' and 'sphinx.ext.intersphinx' to the list of
sphinxcontrib.httpdomain — Documenting RESTful HTTP APIs¶ This contrib extension, sphinxcontrib.httpdomain, provides a Sphinx domain for describing RESTful HTTP APIs. See also We might support reflection for web framework your webapp depends on. See the following sphinxcontrib.auttohttp modules: Module sphinxcontrib.autohttp.flask Reflection for Flask webapps. Module sphinxcontrib.autohttp.bottle
2013/12/15 Sphinx-1.2 をリリースしました & 1.3の計画¶ Category: 'Python', 'Sphinx' Sphinx-1.2リリース¶ 先日、12/10(火)に Sphinx-users.jpの総会 を行いましたが、ちょうど総会開始1時間ほど前に Sphinx-1.2がリリース されました。 昨年2012年11月頭にSphinxのco-maintainerになり(コミッターとは違うの?)その年の年末から年明け頃にリリースされるはずだったバージョン1.2ですが、1年かかってようやくリリースすることができました。 リリースメールに更新のハイライトを箇条書きで載せましたが、主に自分がコードを書いたのは以下のような部分でした。 Python 2.4 サポートの終了 (Georg) Python 3.3 サポートの追加 (清水川) 国際化機能の改善 (清水川)
Enter search terms or a module, class or function name.
去年の12月にPHP のドキュメントを Sphinx で書いてみる (phpautodoc を作ってみた) #sphinxjpという記事を書きました。 その時に、PHP からドキュメントを抽出する phpautodoc というのを作ったのですが、 その後他の作業に夢中になっていたので自分でも使わないまま放置されていました。 ですが、最近ドキュメントを書く時間を作ったので、作りかけの phpautodoc に手を入れて使えるようにパッケージングしてみました。 tk.phpautodoc を使う phpautodoc は gist に貼りつけたままで自分でも使いづらかったので、 あらためて tk.phpautodoc という名前で公開することにしました。 本来であれば、sphinxcontrib-phpautodoc とかにすべきなんでしょうが、 実験的要素がまだ残っているのでちゃんとした名前
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く