Read The Docs (Sphinxドキュメントホスティングサービス) が便利なので紹介 - secretbase.log
Sphinxドキュメントのリポジトリを指定するとビルドとHTMLサイトのホスティングをしてくれるサービス Read the Docs を試してみました。 元ネタ ReadTheDocsでSphinxホスティングは磐石（になる予定） - YAMAGUCHI::weblog 公式ドキュメント 公式 Welcome to Read The Docs — Read The Docs 1.0 documentation 翻訳 Read The Docs ドキュメント — Read The Docs v0.1 documentation (0.1なので少し古い) お試し 下記2つのリポジトリ試してみました。 リポジトリ Read The Docs でできたサイト https://bitbucket.org/devstart/eclipse-cheatsheet http://eclipse-cheat
ドキュメント作成ツールの検討(Sphinx、ReVIEWとか) - wadahiroの日記
今後、マニュアルを書いてメンテナンスも継続的にしていく機会が丁度ありそうなので、現時点(2012/05/02)でどのツールが自分たちにフィットするか検討してみた。ツールの候補は以下。なお、過去の仕事ではWordとDocBookは経験あり。 Word DocBook Sphinx ReVIEW 前提 今回のマニュアル作成の前提は以下の通り。 複数人で作業し、1つのドキュメントを作成する(主に章単位でアサイン)。 特定顧客向けに部分的にカスタマイズして提供することもある。 外部向けのドキュメントなので、体裁はそれなりに整っている必要がある。 製品のエディションによってマニュアル構成が変わる(上位のエディションだと機能が増えるので章や節、説明が増えるなど)。 出力フォーマットはWordまたはHTMLならOK。PDFは必須ではない。 ドキュメント中に画像はそれなりにある。スクリーンキャプチャ、構成
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
github のプロジェクトにSphinxドキュメントを良さげな感じにおきたい 其の二 - Study08.net 対シンバシ殲滅用人型機動兵器
昨日の続き。色々なんか眠いので端折るでしかし。 昨日の話 http://tell-k.hatenablog.com/entry/2012/01/18/224126 面倒な事 昨日までの話だと、こんな感じに、ブランチを切り替えながら作業しなければなりません。 Sphinxドキュメントを編集する -> gh-pagesブランチに切り替えて作業 アプリを開発する -> masterブランチに切り替えて作業 これはめんどくさいですね。そこで「git submodule」を利用して、masterブランチ上に、gh-pagesのブランチをsubmoduleとして持ってしまいましょう。 これにより、ブランチを切り替えることなく、ドキュメントを編集する事が可能になります。 git submodule をつかう git submoduleは、svnの外部リポジトリのような事ができます。実際に下記コマンドを入
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にアクセスすると、ご丁寧にページの作り方
Pythonプロフェッショナルプログラミングを執筆する上で、継続的インテグレーション的なことをやったことについて - cactusman日誌
Pythonプロフェッショナルプログラミング 作者: ビープラウド出版社/メーカー: 秀和システム発売日: 2012/03/26メディア: 単行本購入: 6人 クリック: 765回この商品を含むブログ (27件) を見るPythonプロフェッショナルプログラミングはSphinx+Mercurial+Jenkins+Redmine+SkypeBotの組み合わせで執筆をしていました。 編集のほうで原稿にデザインをあててPDFにするため、最終成果物はその前段階の原稿になります。 それぞれの役割は以下になります Sphinx: ドキュメント作成 Mercurial: ソースコード管理 Jenkins: Sphinxでの定期的なビルド Redmine: タスク管理, Wiki SkypeBot: 各種通知 Mercurial, Redmine, SkypeBotについてはすでに会社に環境があるので、
SphinxでHTMLでもPDFでも見やすい文書を一発で作る
「才能を非生産的な事に浪費してこそ、真のヲタクである」 この名言にかなう為に日々色々学ぶ日々(多分)。 昨年の秋位から Sphinx を本格的に使ってきたので色々メモした事、やった事をまとめて見る。Whyの部分は後で拡充するかも。 後これは俺が買って考えた事なので、これよりいい方法とか知ってる方いたら是非に教えてください。マジで。ホントに。 尚Sphinxを使える用にして、PDFまで出力出来る様にする方法は Sphinxとrst2pdfの「domains」がないよエラー を参照してください。 ■やらないといけない事 取り敢えずやらないといけない要件は以下の通り。 HTMLはHTMLで見やすく。PDFはPDFで見やすく。 PDFは各章に通し番号を振る。HTMLは振らない。 PDFは見出し必須。しかし見出しに載せる深さは2番目まで 内容的に同一の文書を使い回す場所がある。 これに加えて、HTM
今日の日付を埋め込みたい
config.pyで設定ができます。 todayこの値が空でなければ、この値で置換されます。 today_fmt日付の形式を指定します。標準では '%B %d, %Y' です。 なお、languageが指定されて、かつ、そのlanguageで日付の形式が指定されている場合は、その形式が標準となります。 適用例¶ これをビルドした日は 2024年05月16日です。
(5日目) omake を使って Sphinx の自動ビルドを行う - Hack like a rolling stone
Sphinx & blockdiag アドベントカレンダー 5日目です。 今日も Sphinx の tips についてご紹介したいと思います。 Sphinx で文書を作成する際は rst ファイルを書いて、make コマンドを実行する、という繰り返しを行います。 もし rst ファイルの編集中にどのような表示になるのか確認したい場合であっても、 make ファイルを実行して成果物が生成されるまで待つ必要があります。 ビルド処理は実行してから数秒(から数十秒)かかるため、単に表示を確認したい場合でもワンテンポ待つことになります。 これは Sphinx で文書を作る際、少々取っつきづらいところです。 rst ファイルの読み書きになれてくるとどのような表示になるか予測できるようになるため、 表示確認の回数は少なくなりますが、エラーチェックやリファレンスの確認などのために ビルドを走らせたくなるこ
安全加密检测
已通过安全加密检测 如果没有自动跳转，请点击下方按钮前往 欢迎爸爸光临8号购彩360安全卫士提供技术支持 Copyright © 1998 -2020. All Rights Reserved.
さくらインターネットで自動ビルド
さくらインターネットで自動ビルド¶ 日時: 2012/1/25 作者: 渋川よしき Sphinx-Users.jpで2008年ぐらいから使っている方法を紹介します。常駐のできない、一番安価なさくらのスタンダードプランとBitbucketを使う方法です。 この方法には以下のようなメリットがあります。 サーバのパスワードを公開することなく、複数人でコンテンツの管理を行うことができる BitbucketのウェブUIを使って、権限設定などを簡単に行うことができる ウェブのコンテンツをすべてバージョン管理で制御できる 自前のテンプレートや特別な拡張機能がいくらでも使える 問題の報告や管理に、Bitbucketのチケットのシステムが利用できる パッチの受け取りに、pull-requestを使うこともできる リポジトリの準備¶ http://bitbucket.org のサイトにアクセスし、リポジトリを
Sphinxをはじめよう
Sphinxをはじめよう¶ Sphinxを使って、かんたんな書籍紹介のドキュメントを作っていきます。 Sphinxのインストール¶ SphinxはPythonで書かれているため、Sphinxのインストールにあたっては、Pythonのセットアップと、Sphinxのインストールの両方が必要になります。 プロジェクトの作成¶ Sphinxでドキュメントを作るには、まずはドキュメントのプロジェクトを作ります。 Ruby on Rails のScaffoldや、 Django のプロジェクトと似ていて、コマンドラインから、いくつかの質問に答えるとできあがります。 このひな形の作成と、ドキュメントのツリー構造の説明を行っていきます。
Quick reStructuredText
Quick reStructuredText https://docutils.sourceforge.io/docs/user/rst/quickref.html Being a cheat-sheet for reStructuredText Updated $Date: 2022-01-29 23:26:10 +0100 (Sa, 29. Jän 2022) $ Copyright: This document has been placed in the public domain. The full details of the markup may be found on the reStructuredText page. This document is just intended as a reminder. Links that look like "(details)
github pages に Sphinx で生成したドキュメントを公開する。 - kuma8の雑記帳
Github Pages にSphinxで生成したドキュメントを公開するほうほうです。 Github Pages では各リポジトリごとにプロジェクトページを作成することができます。 各プロジェクトごとにページを作成することでマニュアルなどの公開が便利にできます。 Sphinx で生成したドキュメントをそのまま公開すると、スタイルシートなど静的ファイルへのリンクが切れてしまいます。 静的ファイルは、ルートからのパスを想定しているためです。 html 生成時にリンクを修正してくれるプラグインが公開されています。 sphinxtogithub を利用すると、 Github Pages 用のリンクに修正してくれます。 利用方法 1. sphinxtogithub をインストールする。 $ easy_install -ZU sphinxtogithub2. conf.py で、プラグインを有効にする
sphinxやrst2pdfでTypeError: get_language() takes exactly 2 arguments (1 given)
sphinxやrst2pdfでTypeError: get_language() takes exactly 2 arguments (1 given) sphinxやらrst2pdfやらを使っていろいろ書いてるわけなんですが、どうも色々バージョンアップしたら下記のエラーが出るようになっちゃって困った困った。 TypeError: get_language() takes exactly 2 arguments (1 given) んで、もうソースコード書きなおしちゃえってことでdocutilsを書き換えて回避。 副作用は、あんまりないだろう、きっと。 安全にいくなら、virtialenvしてからその配下のを書き換えてくださいね。 (virtualenvってもう古いんだっけ?) command sudo vim /Library/Python/2.6/site-packages/docut
reSTおよびSphinxで文章を書く際のtips - そこはかとなく書くよ。
Sphinxを使って論文っぽい文章を書くときのtipsをまとめておきます。 追記: この内容は Sphinx逆引き辞典により詳細にして載っています。 用語を書く際はreplaceを使う .. |hoge| replace:: ほげらこう定義しておくと次からは |hoge| とするだけで、ほげらと自動的に展開してくれます。つまり、あとからこの用語名を変えたいな、と思ったときにはこの定義のところだけを変えれば勝手に全部入れ替えてくれる、というわけです。 ただし、複数のrstファイルに分けている場合には使えないので、別のファイル(例えばdefinition.txt)に replace を書いておき、 .. include:: definition.txtと各rstファイルの先頭に書いておきます。この時、.rstではなく.txtなど他の拡張子のファイルに書いていることに注意してください。そうしない
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
gist:1716191
Welcome — Sphinx documentation
bitbucketの使い方
Charming Python: Functional programming in Python, Part 3
