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
時雨堂は Sphinx の開発者である小宮健氏のプラチナスポンサーになりました
月 500 ドルなぜスポンサーになったのか時雨堂では自社製品のすべてのウェブドキュメントに Sphinx を利用しています。そのため Sphinx を継続的な開発を少しでもやりやすくしてもらえるようにスポンサーになりました。 個人としても Sphinx は利用させてもらっており、今まで小宮氏への個人的なスポンサーにはなっていました。 ただ今後も Sphinx を自社製品のドキュメントとして使い続けたいという思いから、企業としてメインの開発者である小宮氏への継続的なスポンサーになるべきだと判断しました。 時雨堂がスポンサーになっている開発者Cowboy や Gun の開発者である Loïc Hoguin 氏Blend2D や AsmJit の開発者である Petr Kobalicek 氏Sphinx の開発者である 小宮健 氏 GitHub Sponsors についてGitHub Spons
Sphinx執筆環境をWindowsに構築する手順 - Qiita
この記事はWindowsにてSphinxによるドキュメントを執筆する環境構築の手順を記載します。 Sphinxを利用するプロジェクトに新規メンバーが増えた際に説明が必要となったため書いた記事です。 基本的な文法などはユーザーグループサイトに記載がありますので、本記事では割愛します。 Sphinxとは reStructuredText形式で記述した文章をHTMLやePub、PDF（LaTeX経由）へ出力できる素敵なツールです。 Pythonのドキュメントを作成するために作られたツールのため、Pythonで動作します。 詳細は日本のSphinxユーザグループにより和訳されたオフィシャルページを確認しましょう。 http://www.sphinx-doc.org/ja/stable/index.html なにがいいの？ 例えば、Wordと比較すると以下のようなメリットがあります。 文章を記述する
【全自動】SphinxドキュメントをNetlifyでホスティングする - Qiita
7:40:10 PM: Build started 7:40:10 PM: Fetching cached dependencies 7:40:10 PM: Expected build cache - but failed to find it 7:40:10 PM: Failed to extract cache, continuing with build 7:40:11 PM: No cached dependencies found. Cloning fresh repo 7:40:11 PM: git lfs clone git@github.com:odoku/sphinx-on-netlify-sample 7:40:12 PM: git remote rm origin 7:40:12 PM: Preparing Git Reference refs/heads/mast
blockdiag - simple diagram images generator — blockdiag 1.0 documentation
blockdiag - simple diagram images generator¶ blockdiag and its family generate diagram images from simple text files: Features: Supports many types of diagrams block diagram (w/ blockdiag) sequence diagram (w/ seqdiag) activity diagram (w/ actdiag) logical network diagram (w/ nwdiag) Generates beautiful diagram images from simple text format (similar to graphviz’s DOT format) Layouts diagram eleme
Sphinxをはじめよう 第2版
TOPICS 発行年月日 2017年10月22日 PRINT LENGTH 182 ISBN 978-4-87311-819-2 FORMAT 本書はPythonで標準的なドキュメント作成ツールとして利用されているSphinxの入門書です。Windows、macOS、Linux（Ubuntu）を例に、Sphinxの概要からインストール、基本的な利用法について。またSphinxからLaTeXを経由してPDFを作成したり、EPUBフォーマットの電子書籍を作成する方法を、初めて触れる方にもわかりやすく紹介しています。第2版では、Sphinxの最新バージョンに対応するとともに、画像の埋め込みに関する章とMarkdownを使って文書を作成する付録を追加しています。 なお本書はEbook版およびWeb直販でのみ販売しており、一般の書店では購入できません。 [著者によるサポートリポジトリ] はじめに 1
Sphinxで作る貢献しやすい�ドキュメント翻訳の仕組み
Sphinxには、多言語化サポート機能があります。 この機能を使用せずにSphinxで書かれたドキュメントを翻訳するには、ドキュメントのソースを書き換えることになります。 しかし、この方法には3つの問題があります。 Sphinxの文章フォーマットを壊さないように気をつけなければならない 多数のボランティアによる翻訳の分担がしづらい、ボランティア参加しづらい オリジナルドキュメントが更新されたとき、翻訳ドキュメントを追従させるのが難しい そこで、Sphixnの多言語化サポート機能を利用します。 Sphinxはgettext形式の翻訳カタログの入出力に対応しているので、翻訳支援機能を備えたさまざまなツールやサービスを簡単に利用できます。 翻訳支援サービスを使うことで、Sphinxのドキュメント翻訳は以下のように実施出来ます。 パラグラフ単位で翻訳できる（Sphinxがパラグラフ単位で翻訳カタロ
ドキュメントを作りたくなってしまう魔法のツールSphinx
The document discusses the use of Sphinx for documentation generation in various programming environments, particularly with Python. It includes installation instructions, examples of usage, and different output formats like HTML, PDF, and ePub. Additionally, it mentions various Sphinx extensions and tools for enhanced functionality.
ダメで当たり前なのでどんどんやる。アウトプットしていこう〜 Pythonエンジニア列伝 Vol.1 清水川貴之氏（後編） - Python学習チャンネル by PyQ
やったことをどんどんアウトプットしていこう。アウトプットしないとツッコミが入らない。『わからない』ということをブログに書いていく。最後は理解できて、自分の技術の記録になる。 Pythonエンジニア列伝 Vol.1 - 後編 清水川貴之（シミズカワタカユキ）氏 第一回目は、株式会社ビープラウド所属の清水川貴之氏をお招きました。 Sphinx*1コミッターであり、一般社団法人PyCon JP 会計理事を担当されています。 今回は後編です。 blog.pyq.jp Pythonコミュニティの文化の良いところを教えてください Pythonに限らず沢山コミュニティがありますが、プログラミング言語に関係なく、自分に合うコミュニティかどうか、というのはありますね。 自分にとってPyCon JPというコミュニティの存在は大きいです。スタッフをやっているとコミュニティについて1年間考え続けるし、視野も広がり
Pythonをやるときに参考になりそうな情報 - のんびりSEの議事録
最近あんまり触っていなかったので、久々にPythonをやろうと思ったときにいろいろ忘れてたり、新しく知ったりしたこともあったので、Pythonやるときに参考になりそうな情報をまとめました (但し、今回はデータ分析系のライブラリ関連は除いています) Pythonの言語仕様や基本等 概要 — Python 3.5.2 ドキュメントdocs.python.jp qiita.com www.python-izm.com 2系と3系の違い postd.cc qiita.com コーディング規約 はじめに — pep8-ja 1.0 ドキュメント ドキュメント生成 azunobu.hatenablog.com ドックストリング """ 3重ダブルクォートを使用して記載する。 ドックストリングに記述したテキストは関数やクラスオブジェクトの__doc__に保存される def hello(): """Out
Read the Docs(Sphinx)でオープンソースのドキュメントをいい感じに書いてみる
B! 139 0 0 0 最近良くGitHubなんかで公開されてるオープンソースのドキュメントを見ようとすると こんな感じの似たようなフォーマットで書かれているものが多くなっています。 余りに多いので最初GitHubのサービスかな、とか思ったんですが、 これはまた別のRead the Docsという ドキュメント用ホスティングサービスによるものでした。 Read the Docs Read the Docsでドキュメントを公開してみる Sphinxのインストール レポジトリ側の準備 Read the Docsへの登録 ページを作成 Indexページ ページ内容の編集(Markdown to reStructuredText) タイトル ハイパーリンク 画像 リンク付き画像 インラインマークアップ コードブロック リスト テーブル Pythonのモジュール説明 その他reStructured
海外PyCon発表修行レポート2015 記事一覧 | gihyo.jp
第4回EuroPython 2015参加レポートと、Sphinxに関する発表（後編） 清水川貴之 2015-08-12
Shibu's Diary: Sphinxについていろいろ考え中・・・
渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 Sphinxについていろいろ考え中です。ツールとしてのすばらしさは申し分なく、いろいろ夢が広がりすぎて困ってしまうぐらいです。悩んでいるテーマは２つ。 Sphinx hack-a-thon @aohtaから、公式ハッシュタグについてのアナウンスもあった、Sphinx hack-a-thon。偶然、同日に同じ会場でやることになっている、Python hack-a-thonと共同開催です。やる内容はこんな感じかな、と思っています。 ハンズオン Sphinxをインストールしてみて、料理のレシピか何かのドキュメントを作ってみよう！という30分～50分程度のハンズオン。参考資料は↓このあたり。手前味噌だけど。@MiCHiLUがPDF出力とか説明してくれたりするかな！？ Sphinxドキュ
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
AWS Lambda で Sphinx