ドキュメントの継続的な開発方法 | IIJ Engineers Blog
私はソフトウェア開発を主体とするエンジニアで、 クラウドサービスの開発・運用 分散処理技術の検証とサービス利用の検討 社内の開発支援環境の開発・運用 などの業務に従事していますが、今回の記事は業務とは直接的な関係は無く、私が会社で勝手自発的に行っている取り組みについて書きたいと思います。 昨今、インターネットは生活に深く浸透し、クラウドサービスを利用することで安く簡単にWebサービスを開発、公開できるようになりました。Web技術の進化や流行の移り変りも非常に激しく、既存サービスの機能追加や新規サービスの開発は頻繁に行われています。それは弊社も例外ではありません。 このような開発の現場では、リーンソフトウェア開発への取り組みなど開発手法の最適化が積極的に行われ、様々なベストプラクティスが生みだされています。それらのベストプラクティスには、 継続的インテグレーション や 継続的デプロイメント
Pythonコミュニティに無償のPython IDE、PyCharm 3.0をお届けします！ | Post Blog
PyCharm 3.0をリリースしました！JetBrainsの提供するPython IDEの最新バージョンです。主な新機能は以下の通りです: SQLAlchemy サポート Pyramid & Web2Py web フレームワークサポート 内蔵ターミナル 設定可能な language injections Python、Djangoコード解析の改善 PyQt、PyGTKコード解析の改善 しかし何より一番大きなニュースは: PyCharmは二つのエディション、コミュニティとプロフェッショナルをリリースしました。 そう、つまりオープンソースかつ無償のPyCharmの登場です！ JetBrainsはPythonが長い間科学計算や教育、公共福祉目的で人気のある言語だと認識しています。これらはJetBrainsが伝統的に支持してきたユーザーカテゴリになります。PyCharmの主要機能をより多くの方に
Sphinxをはじめよう
本書には改訂版があります。 Officeツールを使用していて、思うようにならずストレスを感じる事はありませんか？あるいは、印刷用の資料を見ている時に、Webブラウザで閲覧しやすいフォーマットになっていて欲しいと思ったりはしませんか？ 本書はPythonで標準的なドキュメント作成ツールとして利用されているSphinxの入門書です。Windows、OS X、Linux（Ubuntu）を例に、Sphinxの概要からインストール、基本的な利用法について。またSphinxからLaTeXを経由してPDFを作成したり、EPUBフォーマットの電子書籍を作成する方法を、初めて触れる方にもわかりやすく紹介しています。 なお本書はEbook版のみの販売となります。 はじめに 本書を読むにあたって必要な環境とバージョン 本書が想定する読者 本書で使用されている表記規則 サンプルコードの使用について 本書に関するお
https://www.freia.jp/taka/blog/sphinx-i18n-translation-procedure-with-transifex-amazon-s3/index.html
sphinxjp.themes.basicstrap 0.2.0 リリースしました - Study08.net 対シンバシ殲滅用人型機動兵器
というわけで久しぶりのブログ更新。 あれですね2012年いつのまに終わってたんですかね。2012年12月に世界が終わるとかなんとか言ってた人たちは今どんな気持ちで生活してるんですかね。ちょっと話てみたいですね。 sphinxjp.themes.basicstrap 0.3.0 : Python Package Index Basicstrap style theme sample for Sphinx — sphinx theme for basicstrap style documentation そんなわけでSphinxというドキュメンテーションツールのデザインテーマをこさえてみました。Twiter Bootstrapという、今や猫も杓子も使い始めるほどの人気のアレをベースにしてみたテーマです。(実際、猫も杓子も使えるわけではない) 制作に当たっては、面識はございませんが@shkuma
SphinxでCSSのclassを変更する — そこはかとなく書くよん。 ドキュメント
SphinxでCSSのclassを変更する¶ r_rudiさんから引き継ぎました、 Sphinx アドベントカレンダー 2012 21日目です。 Sphinx MLから拾ってきた小ネタです。 Figureをセンタリングしたい¶ figureやimageを使って画像を貼り付けたはいいけど、センタリングしたい！ と言うときがあるかと思います。 そういうときは、以下のように、 :figclass: オプションをつけてみましょ う。こうすると、CSSのクラスに指定したクラスが付け加わります。 この例では align-center というクラスが加わり、センタリングされます。 デフォルトのテーマでは align-center align-right align-left が設定されていますので、お好みに応じて設定すると良いと思います。 あるいは、自分でCSSを定義しておき、好きなクラスを振ることもで
Sphinxで図に番号をつける — そこはかとなく書くよん。 ドキュメント
Sphinxで図に番号をつける¶ Sphinxアドベントカレンダー2012 の20 日目です。 Sphinxで論文などを書くときに "図1 に示す" などのように、図番号への参照 を書きたくなりますよね。 しかし、残念ながらsphinxは標準では番号をつけて図を参照できません。 そこで numfig拡張 の出番です。 インストール¶ # 好きなところに移り % cd /path/to/somewhere # リポジトリをclone % hg clone https://bitbucket.org/arjones6/sphinx-numfig
「最近更新したページ一覧」を生成するsphinx拡張、recentpages ( #sphinxjp アドベントカレンダー 13日目) - 科学と非科学の迷宮
アドベントカレンダーへの参加を大幅に遅刻しました。すいません。 この記事では、私が今年作成した「最近更新したページ一覧」を生成するsphinx拡張、sphinxcontrib-recentpages を紹介します。 sphinxcontrib-recentpages とは？ Sphinx プロジェクト内で作成した rst ファイルを更新された順にソートしてリスト表示するための Sphinx 拡張です。 この拡張を使えば、pukiwiki に標準で備わっている「最近更新されたページ」を表示することができます。 プロジェクトページはこちら: https://bitbucket.org/shiumachi/sphinxcontrib-recentpages インストール方法 easy_install でインストールしてください。 $ easy_install sphinxcontrib-rece
pandoc で Redmine の Wiki を Sphinx に変換しよう - secretbase.log
Sphinx Advent Calendar 2012 - connpass の 15日目のエントリとなります。本日は、pandocというドキュメント変換ツールの紹介です。 Sphinx を使う場合、reSTにてドキュメントを記述しますが、例えばプロジェクト管理にRedmineを導入している場合、Wikiに書きためた文章があるかと思います。RedmineのWikiは textile 記法なので、reSTにうまく変換する方法があったらいいと思いませんか？ そんな textile を reST に変換してくれるツールとして使えそうな pandoc を紹介したいと思います。 pandoc とは pandoc は、ユニバーサルドキュメントコンバータです。 textileだけではなく、入力フォーマットとして、markdown, HTMLなどいろいろあり、出力も reST, markdown はもちろ
Sphinxで出力フォーマットごとに記述を変更する — そこはかとなく書くよん。 ドキュメント
Sphinxで出力フォーマットごとに記述を変更する¶ Sphinx アドベントカレンダー 2012 の14日目です。 Sphinxは一つのrstファイルからhtmlやepubなどいろいろな形式で出力すること が出来ます。出力形式の差はSphinxが吸収してくれるため、普段は処理を意識 する必要はなく単に make html と叩くだけなのがありがたいところです。 しかし、どうしても個々の出力先フォーマットに応じた処理を書きたくなる場 合があります。特に顕著なのが画像の大きさで、htmlとlatexでは画像の大きさ が倍違うことがあります。 そんなときに使えるのが only directiveです。 onlyの例¶ only directiveの例を記します。 .. only:: not latex .. image:: figs/notation3.png :scale: 40 .. on
Home — Sphinx Advent Calendar 2012 (全部俺)
第13日目 Sphinxドキュメントを編集する その１０ 昨日は画像やファイルへのリンクについて説明しました。 今日は 索引(インデックス) について説明します。 索引(インデックス) 一般の技術書等には、大抵最後の方に索引が記載されていると思います。Sphinxでもドキュメントに .. index:: ディレクティブを記述する事により索引を作成する事ができます。
Sphinx + blockdiag による非プログラマのための使える図解の紹介 « sojimn.com
はじめに こんにちは。Sphinx Advent Calendar 2012 の4日目のエントリです。@tk0miyaより受け取りました。 Sphinx を使い始めてまだ日が浅いですが実際に仕事で使ってみてすばらしいツールだと今更ながら気づき、Sphinx に特化したエントリというよりも Sphinx + blogckdiag を使って仕事に使えるダイアグラムの表現方法についてご紹介します。 非プログラマでも簡単に作成ができ修正も簡単、イライラしないでサクサクと図が書けます。 ソフトウェア開発プロジェクトで作成されるドキュメント(特にマニュアルで利用)は顧客に説明するための図解を多用します。これまでの経験で Word/Excel の描画ツールをつかってがんばって作った図 調整と編集がとても大変 Visio を使ってわかりやすく綺麗に作成されているが、Word/Excel/PowerPoi
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Sphinx with Markdown
Sphinxの全文検索を複合語に強くする
Introduction to reStructuredText
GitHub - crosspop/okydoky: Automated docs builder using Sphinx/GitHub/Distribute for use with private projects.
sphinxcontrib.spelling — sphinxcontrib.spelling 1.4 documentation
GitHub - hsk81/notex-v2.0: A text editor for reStructuredText, Markdown, LaTex and more!
sphinxcontrib.issuetracker – Reference issues in issue trackers — sphinxcontrib-issuetracker 0.10.1 documentation
GitHub - OddBloke/sphinx-git: git Changelog for Sphinx