Sphinxで作ったドキュメントのホスティング
Sphinxで作ったドキュメントのホスティング¶ 日時: 2010/09/05 更新日: 2021/04/04 作者: 渋川よしき、山口能迪、清水川貴之、うさたーん Sphinxでドキュメントを作ったら公開したいですよね？自分のホームページ作成のように、FTPを使って、プロバイダーなどで提供されている所に置くというのも当然できますが、ここではいくつか別の方法を紹介します。 Github Pagesを使ってドキュメントを公開¶ Github Pagesを使えば、個人や組織のウェブサイト、リポジトリのウェブサイトを作ることができます。 必要なもの¶ Githubのアカウント git ケース1: 個人や組織のウェブサイトの公開手順¶ ユーザ名.github.io という名前のリポジトリを作成します(ここのユーザ名は個人のアカウント名、もしくは組織名です)。 SphinxでビルドしたHTML群を登
pandoc + sphinx + transifex で既存ドキュメントの翻訳を行う - Hack like a rolling stone
この間の Sphinx+翻訳 Hack-a-thon で話題に上がった件について調査してみた。 お題は以下のとおり。 元の文書は markdown で記述されている Sphinx を使って翻訳してみようと思っている 元の文書が更新された時に差分管理できるとよい その場で出た案はタイトルの通りで、 pandoc で reST 形式に変換して Sphinx を使って gettext 化して sphinx-intl を使って transifex にアップロードして transifex で翻訳をすると良さそう というもの。 gettext 化を挟むことで、翻訳しやすく、また原文の変化を追いかけやすいそうな。 というわけで、実際に試してみました。 環境を作る お題は redis-doc。 まずはワークスペースを作る。 $ mkdir redis-doc $ cd redis-doc $ git in
reStructuredText入門 — Sphinx 1.4.4 ドキュメント
reStructuredText入門¶ このセクションは、reStructuredText(reST)の考え方や文法についての短いイントロダクションです。Sphinxユーザがドキュメントを作成するために十分な情報を提供します。reSTはシンプルに設計された、控えめなマークアップ言語ですので、理解するのにそれほど時間はかからないでしょう。 段落(パラグラフ)¶ 段落(ref)はreSTドキュメントにおける、もっとも基本的な要素です。段落は1行以上の空行で区切られた、シンプルなテキストの固まりです。 Pythonにおいてインデントが重要な意味を持つのと同様、reSTでもインデントは重要です。同じ段落のすべての行は、インデントを同じ高さにそろえて、左揃えにしなければなりません。 インラインマークアップ¶ 標準のreSTインラインマークアップは極めてシンプルです。 アスタリスク1つ: *テキスト*
reStructuredText – ひよっこ。
reStructuredText便利です。はい。 文章を書くときは、これとsphinxで構成するケースが多いです。 ところで便利なreSTなんですが、出来上がりをリアルタイムで確認するようなモノがないのが残念なところです。 Windowsだとrsteditというエディタ&ビューアがあるのですが、 私の環境はMac or Ubuntuなので無理ぽ。 それと自分は、reSTの編集は基本vimですし。 という訳で、何かないかなーと思って探しているとrestviewというものを見つけました。 A ReStructuredText viewerと書いてあるようにシンプルなreSTのビューアのようです。 これとw3m(テキストブラウザ)を使ってvim上でreSTのリアルタイムプレビューできる環境が構築できたので、 忘れないようにログを残しておきます。 必要なもの エディタとしてvim、ビューアとしてr
Jenkinsを使ったSphinxとS3によるドキュメントサイト構築 | DevelopersIO
渡辺です。 開発者の間ではgithub式Markdownでドキュメントを書くのが主流となっている昨今ですが、エンドユーザ向けのドキュメントとなると出力フォーマット・版管理・クロスリファレンスなど、機能的にもう少し欲しいところです。しかし、Wordといった専用の文書作成ソフトを使うほどでもないし、表計算ソフトを使うのは論外だと思われます。 そんな要求を満たすツールはSphinxです。今回は、Sphinxを利用してドキュメントを生成し、Jenkinsによる自動ビルドでHTML形式のファイルを作成し、S3へのリリースする手順を解説してみます。Sphinxは静的ファイルを生成するため、S3やCloudFrontと相性良く利用できるソリューションです。 Sphinxとは？ Sphinxは、ドキュメント生成ツールです。SphinxではPythonで採用されているreStructuredText(reS
https://www.freia.jp/taka/blog/sphinx-i18n-translation-procedure-with-transifex-amazon-s3/index.html
Welcome to Lumache’s documentation! — Lumache 0.1 documentation
Welcome to Lumache’s documentation! Lumache (/lu’make/) is a Python library for cooks and food lovers that creates recipes mixing random ingredients. It pulls data from the Open Food Facts database and offers a simple and intuitive API. Check out the Usage section for further information, including how to Installation the project.
不自然な空白が表示される
不自然な空白が表示される¶ 日本語文章を書いているとHTMLで出力した際に不自然な空白が文章中のところどころに出力される場合があります。これは、段落中で改行するとその改行が空白文字として出力されてしまうからです。 この問題を解決するには日本語拡張を使います。 ここから japanesesupport.py をダウンロードします。 ダウンロードした japanesesupport.py を conf.py を置いてある場所に移動させます。(sourceとbuildを分割している場合はsourceの下、していない場合はMakefileと同じ場所) conf.py を以下のように書き換えます。 sys.path.insert(0, os.path.abspath('.')) # コメントを外します extensions = ['japanesesupport', 'その他の拡張'] # 加えます
国際化 — Sphinx 1.4.4 ドキュメント
Sphinxでは、ナビゲーションバーなどの文字列を各国語にする機能を提供していましたが、 文章 そのものを翻訳する機能を提供します。細かい設定については 国際化のオプション を参照してください。 Sphinx 国際化について¶ gettext [1] は国際化とローカル化の手段として、よく使用されている方法です。プログラム中で使用されるメッセージと、翻訳文字列の対応表を使って置き換えてきます。Sphinxはこの機能を使って、ドキュメント全体を翻訳していきます。 まず最初に、プロジェクトのメンテナーはすべての翻訳文字列を集めてくる必要があります(これを メッセージ と呼ぶ)。これを翻訳者に渡します。Sphinxでは、 sphinx-build -b gettext を実行して、これを行います。 すべてdoctreeの要素は、それぞれがメッセージとなります。巨大なパラグラフは原文のまま残ります
pgRoutingの例で見るsphinx-intlとtransifixの連携 - smellman's Broken Diary
これは Doc-ja Advent Calendar 2013 6日目の記事です。 先日、FOSS4G 2013 Tokyoのハンズオンのため、同僚と一緒にpgRoutingのworkshopの日本語への翻訳を行いました。 pgRoutingは弊社が中心となって開発しているOSSです。 pgRouting自体の説明はpgRouting workshopの日本語版などを参考にして下さい。 pgRouting workshopのドキュメントはSphinxを使って作成をしています。 国際化の部分をsphinx-intlを使って行い、transifexを使って共同作業で翻訳を行っています。 今回は実際の翻訳作業を通して得た知識を元に説明をします。なお、pgRoutingの例で見るとありますが、そこまでガッツリpgRouting絡んでないので安心してください(何 今回の作業では主に以下の４つの作業を
Sphinx-Users.jp :: ドキュメンテーションツール スフィンクス Sphinx-users.jp
Sphinx-Users.jp¶ Sphinx-Users.jp(略称#sphinxjp)は、美しいドキュメントを簡単に生成することができるドキュメンテーションツール、 Sphinx （スフィンクス）の普及を主眼としたコミュニティです。SphinxはPythonの公式ドキュメントだけでなく、このSphinx-Users.jpのサイトも含め多くのマニュアルやサイトで使用されており、詳細を Sphinxの歴史で紹介しています。 Sphinx-Users.jp は日本の Sphinx コミュニティです。 Sphinx-Users.jp では、日本で散らばっているSphinx関連情報を集めて、Webサイト、イベントを通じてSphinx情報を発信します。 slack のコミュニケーションや勉強会の開催などを通じて、ドキュメントをパワーアップしたい人、ドキュメントや翻訳で苦労している人、Sphinxの
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Internationalization — Sphinx documentation
https://www.freia.jp/taka/blog/sphinx-i18n-translation-procedure-with-transifex-amazon-s3/