Python製静的サイトジェネレーターSphinxでWebサイトを構築して公開 | gihyo.jp
鈴木たかのり（@takanory）です。今月の「Python Monthly Topics」では、Python製の静的サイトジェネレーターSphinxを使用してWebサイトを構築し、テーマを適用、外部へ公開する流れについて紹介します。後半ではSphinxの便利な拡張機能を紹介し、Webサイトをより便利にしていきます。 Markdownでドキュメントを書くだけで、きれいなWebサイトが簡単に公開できるので、ライブラリのドキュメントなどでもよく使われています。 Sphinxとは SphinxはPython製の静的サイトジェネレーターです。静的サイトジェネレーターとは、Markdown等の軽量マークアップのテキストファイルから、静的なWebサイトを生成するアプリケーションのことを言います。Python製の静的サイトジェネレーターにはSphinxを含め以下のツールなどがあります。 Sphinx：h
Shibu's Diary: 「Real World HTTP」が出版されます！
昨年から書いていたReal World HTTPがAmazonのページに表示されるようになりました。最初にコミットしたのは昨年の8/1ですが、たぶん、その数ヶ月前から書き始めていたと思うので、ほぼ丸一年です。途中でASCII.jpのシステムプログラミングの連載が始まったり、Software DesignにSphinxについて寄稿したり、もう１つ別の翻訳の企画があったり、三女が7/4に生まれたり、なかなかハードな一年間でした。 なお、表紙は皆さんが知っているものとはちょっと違うのですが、系統的に一番近いのがハシビロコウさんらしく、和名もそれしかないそうです。狙っていたわけではなく、そもそも出版時期にはアニメも終わってしまっているし、話題の動物は辞めたほうが良さそう、という話をしていたのですが、偶然これが選ばれました。 本の内容の紹介 裏表紙の紹介はこんな感じです。 本書はHTTPに関する技術
Gitlab CIを使ってSphinxのドキュメントを自動でPDFにビルドする - once upon a time,
gitlab.comは自前でDocker image登録できたり、CI持っていたりと便利ですね。しかも、privateレポジトリもお金かからないという太っ腹。 技術書典2に向けたレポジトリはgitlab.comで管理しています。 今回は共著者にPython使いが多いためSphinxを使って書いているんですが、Sphinxはcommon markでも書けるのでmarkdownでも文章を書くことが出来ます。 前回の記事では、数式入りのmarkdownからPDFを生成するDocker imageを作りましたが、それを使うと簡単にGitlab-CIでPDFが生成できます。 chezou.hatenablog.com やり方は簡単、あなたのSphinxのプロジェクトに、以下のような.gitlab-ci.ymlを書くだけ。もちろん、必要に応じてpathsは変更してください。 image: chezou
ドキュメントシステムはこれを使え2015年版
12. 思いつくキーワードを挙げてみた POD Javadoc など WEB Sphinx Re:VIEW EWB CAS-UB Atlas Gitbook PressBooks Booktype IGP digital publisher BCCKS でんでんコン バータ Markdown Wiki 記法 reStructuredText RD、RDoc AsciiDoc HTMLBook DocBook DITA、JATS LATEX とか Docutils Calibre Pandoc Word（MS Office） Writer（LibreOffice） Adobe InDesign Adobe FrameMaker AH Formatter Prince Apache FOP Vivliostyle TEX エンジン ブラウザエンジン CSS Books cl-typesetting +
"ドキュメントを部分的に公開/非公開にしてビルドする"の実用例 - logiqboard
Sphinx Advent Calendar 2012: 18日目 おひさしぶりのfeizです。久しぶりついでにはてブロに移行してみました。 先日、こんなcookbookを投稿しました。 ドキュメントを部分的に公開/非公開にしてビルドする :: ドキュメンテーションツール スフィンクス Sphinx-users.jp 仕事でお客さん向けのドキュメントを書いてると結構需要のある話なんじゃないかなーと思ってます。 ただ、cookbookには実際の利用例みたいなものをあまり入れられなかったので、この機会に実用例や設計手順をまとめてみようと思います。 前提とするシチュエーション 以下のようなシチュエーションを想定します。 とあるB2BサービスのAPIサーバーを書いている 自社(開発)→サービス元(サービス運用)→エンドユーザー(複数社) サービス元とエンドユーザーと自社内の3ロールにそれぞれドキュ
Accel Series ダウンロードライブラリ - intra-mart
本サイトはドキュメントライブラリへの統合を予定しております。統合した際には、こちらのURLにアクセスした場合、ドキュメントライブラリの移行先のページへとリダイレクトが実行されます。
rst2pdf で reStructuredText から PDF を生成する : 紹介マニア
パッケージシステムを利用してのインストール fink や MacPorts を利用していれば easy_install を利用してインストールできます。 以下は fink と easy_install を利用してのインストール手順です。 sudo fink install jpeg sudo fink install freetype219 sudo fink install lcms sudo easy_install -UZ PIL sudo easy_install -UZ reportlab sudo easy_install -UZ rst2pdf curl -O http://www.ijg.org/files/jpegsrc.v7.tar.gz tar zxvf jpegsrc.v7.tar.gz cd jpeg-7 ./configure --enable-shared -
https://www.freia.jp/taka/blog/sphinx-i18n-translation-procedure-with-transifex-amazon-s3/index.html
tinkerer.me - Domain Name For Sale | Dan.com
Buyer Protection Program When you buy a domain name at Dan.com, you’re automatically covered by our unique Buyer Protection Program. Read more about how we keep you safe on our Trust and Security page. Next to our secure domain ownership transfer process, we strictly monitor all transactions. If anything looks weird, we take immediate action. And if the seller doesn't deliver on their part of the
reSTおよびSphinxで文章を書く際のtips - そこはかとなく書くよ。
Sphinxを使って論文っぽい文章を書くときのtipsをまとめておきます。 追記: この内容は Sphinx逆引き辞典により詳細にして載っています。 用語を書く際はreplaceを使う .. |hoge| replace:: ほげらこう定義しておくと次からは |hoge| とするだけで、ほげらと自動的に展開してくれます。つまり、あとからこの用語名を変えたいな、と思ったときにはこの定義のところだけを変えれば勝手に全部入れ替えてくれる、というわけです。 ただし、複数のrstファイルに分けている場合には使えないので、別のファイル(例えばdefinition.txt)に replace を書いておき、 .. include:: definition.txtと各rstファイルの先頭に書いておきます。この時、.rstではなく.txtなど他の拡張子のファイルに書いていることに注意してください。そうしない
sphinxjp.themes.trstyle
Unverified details These details have not been verified by PyPI Project links Homepage Meta License: MIT License (MIT) Author: TriAx Corp Tags sphinx, reStructuredText, theme Business style documentation theme for Sphinx. Features provide trstyle theme for render HTML document. Set up Make environment with easy_install: $ easy_install sphinxjp.themes.trstyle Convert Usage setup conf.py with: exten
ReadTheDocsでSphinxホスティングは磐石（になる予定） - YAMAGUCHI::weblog
はじめに こんにちは、Sphinx-Users.jpの賑やかし担当です。最近PHP界隈でも人気の高いドキュメント生成ツールSphinxですが、みなさん楽しいSphinxライフを送っていますでしょうか。さて、Sphinxでドキュメントを作った場合、一番キャッチーなのはHTMLだと思うんですが、そのホスティングはみなさんどうされていますか？ Sphinx-Users.jpにいくつかホスティングの方法を紹介してありますが、今日は割と新しいホスティング方法のReadTheDocsをご紹介します。 ReadTheDocsってなに？ Home | Read the Docs rtfd/readthedocs.org · GitHub ReadTheDocsは2010年のDjango Dashで作成されたコードを元に公開されているサービス/ライブラリです。外部に公開されているSphinxのレポジトリ（G
海外で作られたPython製ノベルゲーム制作ツール、Ren'Pyのドキュメント日本語訳(途中)を仮公開しました！ - プログラマ行進曲第二章
昨日2/12(土)にオラクル青山センターで開かれた"Sphinx + 翻訳 Hack-a-thon 2011.02"というイベントに参加してきました。このイベントは「Sphinx」*1というPython製のドキュメント生成ツールと「翻訳」に興味がある人を対象にした勉強会で、色々思うところがあってこのたび参加してきました。何故参加したか？といったことや参加するに至った経緯は別のエントリでまとめて公開する予定なので、後で合わせてそちらも読んでいただければと思います。 前置きが長くなりましたが、本題です。あまりに長くなったので、要点だけ知りたい方は最後のまとめまでスキップしてください。 前述したイベント、"Sphinx + 翻訳 Hack-a-thon 2011.02"で私はRen'PyというPython製ノベルゲーム制作ツールのドキュメントを翻訳しようと思って参加しました。そしてイベント参加者
Quick Sequence Daigram Editor — Quick Sequence Diagram Editor v3.0.4 documentation
サマリー¶ Quick Sequence Diagram Editorは、オブジェクトとメッセージに関するテキスト形式からUMLのシーケンス図を生成するツールです。 このツールは、スレッド、アクター、コンストラクタ、デストラクタ、注釈、フラグメントをサポートしています。 このツールの狙いは、ゆるすぎる柔軟性とトレードオフすることによって、WYSIWYGのアプリケーションで必要とされる、面倒な数多くの作業からあなたを救い出すことにあります。オブジェクトやメッセージを追加したり削除したりといった作業では、断然他のアプリケーションよりもすばやく行えます。この手の作業は、テキストの行を追加したり削除することによって行うことができ、ツール側でレイアウトなどの他の作業をすべて引き受けます。 機能¶ 以下のような機能を持っています 自動再描画 - 文字をタイプするのに連動して、図が自動で変更されます 文
Gruffyのグラフを簡単に作成できるSphinx拡張をリリースしました | hexacosa.net
sphinxcontrib-gruffygen という Gruffy のグラフが作成できる Sphinx拡張をリリースしました。 以下のようにドキュメント内に書くと、冒頭のような感じでグラフが出力されるようになります。 .. gruffy:: :title: Gruffy's Graph :width: 500 :type: Line data("Apples", [1, 2, 3, 4, 4, 3]) data("Oranges", [4, 8, 7, 9, 8, 9]) data("Watermelon", [2, 3, 1, 5, 6, 8]) data("Peaches", [9, 9, 10, 8, 7, 9]) labels = {0: '2003', 2: '2004', 4: '2005.09'}
OMakeでSphinxを自動継続ビルドしてみよう
題名通りです。Sphinxっていうドキュメント作成ツールがあって、これがなかなか簡単に作れる、かつ様々なフォーマットの書き出しに対応してるのですごく使いやすい。 Sphinxについて詳しく知りたい方は以下のURLを参照すればいいような気がします。 Pythonって何？という人のためのSphinxインストール入門 しかしSphinxには自動でプロジェクトのMakefileが生成されるので簡単にビルドできるようになっているんですけど、それでもhtmlファイルをrstファイルが変更される度に自動ビルドしてくれたらもっと便利になるのにとか思うのが人の常。 というわけで、前回の記事と絡めて、OMakeでSphinxを自動継続ビルドしてみようというのが今回の記事の目的です。 まずはOMakeのインストールからまず、OMakeっていうのはGNU/BSDのmakeもどきみたいなソフトです。でも「もどき」っ
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Documenting Your Project Using Sphinx — an_example_pypi_project v0.0.5 documentation
Notex.ch · Markdown Editor
Bitbucket | Git solution for teams using Jira
GitHub - coordt/ADCtheme: A Sphinx theme that formats documentation like the Apple Developer Connection
