Docz
Powered by GatsbyStarting from v2, Docz is entirely built using GatsbyJS. It's optimised for a lightning fast development experience and speedy build times. This also allows you to leverage GatsbyJS's huge ecosystem of plugins and tools. Zero configNo need to worry about complex configuration settings to build and run your documentation. With Docz you can create customizable sites with a single co
pptshape
Unverified details These details have not been verified by PyPI Project links Homepage Meta License: BSD License (BSD) Author: Atsuo Ishimoto Pptshape extracts shapes from ppt file and embeds to the sphinx document as png file. pptshape adds new directive as follow. .. ppt-shape:: abc.png :pptfilename: testppt.pptx :shapename: shape-title First line of the directive specifies filename of image fil
はやわかり reStructuredText
本マークアップ記法の完全な詳細は reStructuredText のページに示されています。このテキストは、覚書としての性格の文書です。 "(詳細)" というリンクを辿ると reStructuredText 仕様書を参照できます。 ただし、相対リンクとなっていますので、リンク切れの場合は、 原版の "Quick reStructuredText" から参照してください。 目次 インライン マークアップ バックスラッシュによるエスケープ 章立ての構造 段落 記号つきリスト 番号つきリスト 定義リスト フィールドリスト オプションリスト 整形済みブロック ラインブロック 引用 Doctestブロック 表 区切り線 明示的マークアップ 脚注 出典 リンクターゲット 外部ターゲット 内部ターゲット 間接ターゲット 暗黙ターゲット ディレクティブ 代入参照とその定義 コメント 助けを得たい場合は
ファイルを超えてリンクを貼る (domain#resolve_xref() のすゝめ) - Hack like a rolling stone
昨日の記事で、どの拡張も HTML に変換した時に他のページにリンクできないという体たらくなので、 Sphinx においけるリンクの解決方法をまとめておく。 解決方法: domain#resolve_xref() を使う 以上。 見出しで言い切ったのでこれ以上ネタも無いのだが、コードを使って補足しておく。 Sphinx のベースになっている docutils では、単体のファイルしか扱わないため ラベルを意味する reftarget ノードとリンク(参照)を表す reference ノードのふたつで用が足りていて、 リンクの解決はドキュメントの先頭から travrese() をして、該当のラベルを見つけるだけでよかった。 しかし、Sphinx では複数のファイルを組み合わせて文書を構築するため、 ファイル A からファイル B へリンクすることもある。 だが、ファイル A にあるリンクを解
コード片(code-block)にキャプションをつける - Hack like a rolling stone
rstのファイルでリストに通し番号を入れる（久々にシェル芸） を見て、"code-block にキャプション付けられなかったっけ?" とおもって調べてみたところ、 Sphinx の code-block ディレクティブも docutils の code ディレクティブもどちらもキャプションをサポートしていませんでした。 僕らが普段目にする雑誌では、コード片にはそれぞれ「リスト 1. 〜〜〜」のようなキャプションがついています。 それと同様の記述は Sphinx ではできないのでしょうか。 よろしい、ならば拡張だ 標準のディレクティブを書き換えるのは気が進まない*1のですが、目的のためならば手段は選んでいられません。 早速 code-block ディレクティブを書き換えることにしましょう。 ということで、書き換え終わったものがこちらです。 code-block ディレクティブに :capti
Available lexers — Pygments
Available lexers¶ This page lists all available builtin lexers and the options they take. Currently, all lexers support these options: stripnlStrip leading and trailing newlines from the input (default: True) stripallStrip all leading and trailing whitespace from the input (default: False). ensurenlMake sure that the input ends with a newline (default: True). This is required for some lexers that
取り消し線を引きたい
取り消し線を引きたい¶ Sphinxには取り消し線(sタグ)をマークアップする記法がありません。 取り消し線を使う場合には、新しくロールを定義し、それをクラス名としたスタイルシートを用意します。 追加するロール:
Sphinxで打ち消し線を使う | Webシステム開発／教育ソリューションのタイムインターメディア
Sphinx プロジェクトのディレクトリに以下の内容を sphinxcontrib_roles.py という名前で保存します。 ここでは strike、red という二つのロールを定義しています。 CSS の定義でそれぞれ打ち消し線表示、赤い文字にする、という表示にしています。 あとは reST 本文の中でこれらのロールを指定するだけです。 たとえば :strike:`ここは打ち消し線表示` と書いて HTML ファイルを生成すると 以下のように出力されます。 HTML 以外のフォーマットでは効果がありませんが、 HTML 出力はよく使われると思うので程よくマークアップすると良いと思います。 ただ、見た目ばかりに気を取られると Sphinx(reST) のメリットが薄れていくのでご注意を。
ディレクティブの紹介
ディレクティブの紹介¶ このドキュメントではreStructuredTextパーサで実装されているディレクティブについて説明します。 ディレクティブは下記の構文です。: +-------+---------------------------------------------------+ | ".. " | ディレクティブタイプ "::" ディレクティブブロック | +-------+ | | | +---------------------------------------------------+ ディレクティブは明示的なマークアップ（二つのピリオドとスペース）からはじめ、ディレクティブタイプと二つのコロン（まとめて"ディレクティブマーカー"）が続きます。ディレクティブブロックは、ディレクティブマーカーのすぐ後からはじまり、その後の全てのインデント行が含まれます。ディレクティブブ
oinume journal
Raycastを使い始めて1年経ったので、どういうことに使っているかを振り返ってみる。去年書いた AlfredからRaycastに移行した - oinume journal の記事から少し使い方が変わっているところもあるのでメモがてら。 基本的な使い方 Cmd + QをRaycast起動のショートカットとして割り当てている。Pro版は使っていないのでAI機能などは使ったことがない。 ブラウザのブックマーク検索など、よく使うけどHotKeyを割り当てるほどでもないRaycastコマンドはbmのようにAliasを設定している。 Cmd + QでRaycastを起動してbmと入力するとブックマークの検索ができるので楽ちん アプリケーションランチャー機能 アプリケーションを起動するときのランチャーとして使っている。よく使うアプリにはHot Key(ショートカット)を割り当ててる。 Clipboar
ドキュメント作成ツールの検討(Sphinx、ReVIEWとか) - wadahiroの日記
今後、マニュアルを書いてメンテナンスも継続的にしていく機会が丁度ありそうなので、現時点(2012/05/02)でどのツールが自分たちにフィットするか検討してみた。ツールの候補は以下。なお、過去の仕事ではWordとDocBookは経験あり。 Word DocBook Sphinx ReVIEW 前提 今回のマニュアル作成の前提は以下の通り。 複数人で作業し、1つのドキュメントを作成する(主に章単位でアサイン)。 特定顧客向けに部分的にカスタマイズして提供することもある。 外部向けのドキュメントなので、体裁はそれなりに整っている必要がある。 製品のエディションによってマニュアル構成が変わる(上位のエディションだと機能が増えるので章や節、説明が増えるなど)。 出力フォーマットはWordまたはHTMLならOK。PDFは必須ではない。 ドキュメント中に画像はそれなりにある。スクリーンキャプチャ、構成
Shibu's Diary: ブラウザ上で動く検索エンジンOktavia
渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 HTML5アドベントカレンダー向けのエントリーです。ブラウザでできることがどんどん増えています。2013年に一部で熱狂的な話題となった本の高速文字列解析の世界 を読んで意識が高まったので、勢いにまかせてブラウザで動く検索エンジンを作ってみました。写真は著者の岡野原さんにお会いしたときにいただいたサインです。 ブラウザ上の検索エンジンと転置インデックスと東アジアの微妙な関係 全然調べていないので、歴史とかよくわからないのですが、僕が始めてブラウザ上で動く検索エンジンと出会ったのは、Sphinxです。SphinxはPythonで書かれたドキュメントツールです。ドキュメントツールというとJavaDocを始めとして各種あります。大きく、自然言語中心のもの(Texとか)と、APIリファレ
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
このページについて — 苦労する遊び人の玩具箱 1 ドキュメント
GitHub - cgwrench/rst2md: A Docutils writer for converting from reStructuredText documents to Markdown.
My Future Sight for Past: SphinxCon JP 2014参加レポート
Blog | Enthought, Inc.
Sphinxドキュメント — Sphinx 1.4.4 ドキュメント
riv.vim/doc/riv_quickstart.rst at master · gu-fan/riv.vim
The Cloud Sphinx Theme — Cloud Sphinx Theme v1.10.1 Documentation
Sphinx autosummary "toctree contains reference to nonexisting document" warnings