sphinxcontrib-plantuml
Verified details These details have been verified by PyPI Maintainers yuja Unverified details These details have not been verified by PyPI Project links Homepage Download GitHub Statistics Installation pip install sphinxcontrib-plantuml Usage Add sphinxcontrib.plantuml to your extensions list in your conf.py: extensions = [ 'sphinxcontrib.plantuml', ] You may also need to specify the plantuml comm
(6日目) Sphinx 拡張の紹介 - Hack like a rolling stone
Sphinx には Sphinx 拡張(Sphinx extension)と呼ばれるプラグイン機能があります。 Sphinx 拡張を使うとドキュメントを書くのがより便利になったり、 ドキュメントの表現がより豊富になったりします。 今日はその Sphinx 拡張の中から僕がよく使うもの、便利そうで使ってみたいものを それぞれいくつかピックアップしてご紹介します。 sphinx.ext.todo Sphinx に同梱されている拡張モジュールで、ドキュメントに ToDo を書き残すことができます。 有効にするには conf.py に以下の記述を追加します。 # sphinx.ext.todo モジュールを読み込む extensions += ['sphinx.ext.todo'] # ToDo 項目を表示する (デフォルトは表示しない; False) todo_include_todos = T
Dotted style theme sample for Sphinx — sphinx theme for dotted style documentation
sphinx theme for dotted style documentation Dotted style theme sample for Sphinx Contents :: Readme » Readme conf.py sample Sample Document History and Authors Dotted style theme sample for Sphinx¶ Quick start¶ install: $ pip sphinxjp.themes.dotted setup your conf.py with: html_theme = 'dotted' and run: $ make html then your will get this page’s style HTML output. Links¶ download:https://github.c
github のプロジェクトにSphinxドキュメントを良さげな感じにおきたい 其の一 - Study08.net 対シンバシ殲滅用人型機動兵器
大分前にこんな感じの事をしたので、その時の覚え書き。githubで管理されているOSSなんかでは良く、下記のようなURLでドキュメントを公開しているプロジェクトがありますよね。 http://[account_name].github.com/[repository_name]/ account_name(アカウント名)がサブドメイン repository_nameが対象のリポジトリ名 これどうやってんだろう？と思ってたのがきっかけです。以下手順を見てみましょう。前提として既にgithub上にリポジトリを持っていることとします。 GitHub Pagesを用意する そもそも、上のURL体系でページが参照できるのは、Github Pagesのおかげのようなので、まずはこれを用意します。Github Pagesを利用していないリポジトリで上のようなURLにアクセスすると、ご丁寧にページの作り方
Auto-building Sphinx docs - Jacob Kaplan-Moss
I wrote this post in 2012, more than 11 years ago. It may be very out of date, partially or totally incorrect. I may even no longer agree with this, or might approach things differently if I wrote this post today. I rarely edit posts after writing them, but if I have there'll be a note at the bottom about what I changed and why. If something in this post is actively harmful or dangerous please get
私的Sphinxインストールマニュアル
ドキュメントというより、変更履歴を書くのが無性に面倒くさい。いや、そもそも変更履歴を見ただけじゃ、何を変えたか後から分からないでしょ。 あっちいったり、こっちいったりするのは面倒なのでまとめておく。 全部入れてもOKかどうかは試していないので、そこは自己責任でお願いします。 1.インストール インストールはマニュアルどおりに。 Windowsへのインストール :: ドキュメンテーションツール スフィンクス Sphinx-users.jp オールインワンを使わないのは、Sphinxのバージョンが古いから。 2.日本語環境設定 日本語のファイル名や文章にするときは以下のことをする。 1)日本語フォルダ/ファイル名を扱えるようにするパッチの適用 [Sphinx][Cygwin] 日本語フォルダ/ファイル名を扱えるようにするパッチを作った #sphinxjp | 半袖野郎 blog.hansod
GitHub PagesでSphinxを使ってみる - 日々常々
http://pages.github.com/ GitHub Pages というものがある。簡単な規則に沿ってページを作ればサブドメインでのページが作れる感じのサービスと認識した。規則は簡単。 irof.github.com というリポジトリを作る そこに index.html を置く そしたら後はGitHubが勝手に良いようにしてくれて、http://irof.github.com/ でアクセスできるようになる。素晴らしい。（この時点では「hello, world」とだけ書いてた） でもHTMLなんていちいち書いてられないし、GitHub Pagesで紹介されているようなJekyllなんてのは知らない…と言うかHTMLはSphinxで出したい。 しかし素直に sphinx-quickstart で出力したHTMLをpushしたところで、GitHub Pagesは _ で始まるのを対象と
Sphinx で Github pages する (sphinx-to-github の submodule ぶんどりから html を吐いて push するまで) - kozo2's blog
タイトル通りのことをする。 アカウント名.github.com という名前のリポジトリを作る それcloneする cd アカウント名.github.com git submodule add git://github.com/michaeljones/sphinx-to-github いっぺんとりあえず git commit -m "added sphinx-to-github as submodule" && git push する sphinx-quickstart (全部適当にenter、なんかいれなきゃなんないのは適当に書いてenter) rm -rf _* conf.py の中を html_static_path = ['static'] と変更 アンド extensions = [ "sphinxtogithub" ] と変更 アンド 末尾にでも sphinx_to_githu
Sphinx で商用のウェブサイトを立てて 4 ヶ月が過ぎた - Twisted Mind
Sphinx で会社の製品サイトを作って 4 ヶ月以上過ぎました、実際に運用してみた感想などを。 前提 デザイナー @kinofumi に依頼して、Sphinx の専用テーマを作って貰いました。@kinofumi は Jinja2 も使いこなしてしまったりとデザイナー？なのか怪しいですが、とてもステキなサイトが出来ました。 商用製品サイトなので、とにかく見やすいこと、知りたい情報が見つかることが第一に作って貰いました。 リリース環境 S3 にデプロイしてパーミッションを Public にしています。URL は DNS 指定しているだけです。 それ以上は特にやっていません。 費用 アクセスが 1 日 100 人未満です。そもそも 1000 人も見に来るようになったら問題です。 で、実際いくらかかったのよ、という話しです。 今のところ三ヶ月連続で $ 0.03 で、今月も今のところ $ 0.0
ドキュメント作成ツールの検討(Sphinx、ReVIEWとか) - wadahiroの日記
今後、マニュアルを書いてメンテナンスも継続的にしていく機会が丁度ありそうなので、現時点(2012/05/02)でどのツールが自分たちにフィットするか検討してみた。ツールの候補は以下。なお、過去の仕事ではWordとDocBookは経験あり。 Word DocBook Sphinx ReVIEW 前提 今回のマニュアル作成の前提は以下の通り。 複数人で作業し、1つのドキュメントを作成する(主に章単位でアサイン)。 特定顧客向けに部分的にカスタマイズして提供することもある。 外部向けのドキュメントなので、体裁はそれなりに整っている必要がある。 製品のエディションによってマニュアル構成が変わる(上位のエディションだと機能が増えるので章や節、説明が増えるなど)。 出力フォーマットはWordまたはHTMLならOK。PDFは必須ではない。 ドキュメント中に画像はそれなりにある。スクリーンキャプチャ、構成
github pagesをsphinxを使ってwiki的に使う。 - 目の前に僕らの道がある
いちいちやり方を調べるのがめんどうなので、自分メモ。commit pushが必要ですが、自分wiki立てるのがめんどうならこれくらいで充分かなと。 ${USER_NAME}と${REPOSITORY_NAME}は適宜自分の環境に置き換えてください。 準備 あらかじめ、githubにレポジトリを作っておきます。 sphinxとsphinx-to-githubをインストールしておきます。pythonはpythonbrewなりシステムのなり、どっかから適当にインストールしてください。 pip install sphinx pip install -e "git+git://github.com/michaeljones/sphinx-to-github.git#egg=sphinx-to-github" プロジェクトの作成 いつものようにgitのローカルレポジトリを作成し、sphinxの雛形を作
GitHub PagesでSphinxを使う
GitHub Pagesを使って文書を管理したら快適そうだったので試してみた。 ゆるふわHaskellというものを書いてます。 Haskellで人工無脳をつくってみたいとか、PLEAC埋めたいとか、Invent with Pythonを書きなおしてみたいとか色々あったのでGitHub+Sphinxでやりたくなったというのがモチベーション。 基本的な流れとしては gh-pagesというブランチを作る sphinxtogithubというエクステンションを入れる Sphinxで文章を書く make htmlする cp -pr _build/html/* ./でビルドされたhtmlをカレントディレクトリに移動する commitしてpushすると公開できるようになる となるが、4-5のステップはもうちょっとスマートにできると思う。ちなみに参考にしたのが以下のサイトだけど、オフィシャルのヘルプには一通
Sphinx 文書に markdown フォーマットを利用する - Hack like a rolling stone
この記事は Sphinx アドベントカレンダーの 19日目です。 markdown と Sphinx (reST) Sphinx では文書を書く際の記述フォーマットに reStructured Text を利用していますが、 世を広く見回すと、github 然り、bitbucket 然り、様々な場所で markdown フォーマットが利用されています。 markdown フォーマットは reST と比べると表現力が低い上、表現を拡張することができないという点が指摘されています。 表現を拡張することができないため、いくつかの方言が存在するという問題もあります。 ですが、reST と比べてシンプルで、なおかつポピュラーに利用されているフォーマットであるため、 新しく Sphinx に触り始める人の取っ掛かりとしては、markdown はうってつけのフォーマットと言えます。 sphinxcont
Sphinxで薄い本を書いてみた - 検討!目論見委員会Z
Sphinx Advent Calendar 2012 - connpass の23 日目です。 昨日は Harrison さんの Sphinx アドベントカレンダー22日目 でした。壁ドンって重ねるとたのしいですよね。壁壁ドンドン*1。関係が前に進みそうな感じですね*2。ということでAdvent Calender初参加でございます*3*4。 はじめに Sphinx界隈の皆様、はじめまして。柱脚の多さで定評のある @tboffice と申します。よろしくお願いします*5。 Sphinxで薄い本を作った話をします。薄い本については最後の方で触れます。 そもそも 実は、このエントリのタイトルにもなっている「薄い本」は、今年の夏頃にも作りました。そのときは複数人で素のtex原稿を書いて持ち寄って、dvipdfmxコマンドをたたいてビルドしていました。 そのとき一緒に執筆していたid:j5ik2o
Sphinxのテーマにtwitter bootstrapを使う
で使えるようになる。 あまりCSSをいじる気がなければこれでいいかなと思うが、弄りたい場合にはこっちのやり方のほうがいいかな。 あとで何かで使ってみようっと。
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/
Overview — Sphinx v1.0.7 documentation
Sphinx makes it easy to create intelligent and beautiful documentation. Here are some of Sphinx’s major features: Output formats: HTML (including Windows HTML Help), LaTeX (for printable PDF versions), ePub, Texinfo, manual pages, plain text Extensive cross-references: semantic markup and automatic links for functions, classes, citations, glossary terms and similar pieces of information Hierarchic
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
sphinxcontrib-coffee
https://sphinx-users.jp/hack/
shomah4a.net