Skip to content

Instantly share code, notes, and snippets.

View shimizukawa's full-sized avatar

Takayuki SHIMIZUKAWA shimizukawa

142 followers · 8 following
View GitHub Profile
@shimizukawa
shimizukawa / _出力ルール.txt
Last active November 11, 2016 15:53
sphinx拡張: shuwa builder
文頭は、一文字下げ
○章扉リード文（タグ不要）
○第1レベル見出し（節見出し） ■■■■
○第2レベル見出し ■■■
○第3レベル見出し ■■
○第4レベル見出し ■
▽●コラム
@shimizukawa
shimizukawa / README.rst
Created November 11, 2016 11:57
Sphinx拡張 コラム用マークアップ column ディレクティブ column.py

column.py を 以下のように配置:

sphinx-project/
+- index.rst
+- conf.py
+- ext/column.py
+- _static/custom.css

conf.py に設定を追加

@shimizukawa
shimizukawa / README.rst
Last active October 23, 2018 12:51
Sphinx拡張 文字数表示パネル pageinfo.py

pageinfo.py と pageinfo.html を以下のように配置:

sphinx-project/
+- index.rst
+- conf.py
+- ext/pageinfo.py
+- _templates/pageinfo.html

conf.py に設定を追加

@shimizukawa
shimizukawa / README.md
Last active November 5, 2015 12:52
SphinxCon 2015 概要

(English version is put later)

今年の SphinxCon JP のテーマは「色々やってみよう」です。

Sphinxには多くの機能があり、色々な使い方ができます。 Sphinxがいまどのような分野で使われているのか、どんな機能があるのか、幅広く知るきっかけになればと思います。他の人のプレゼンテーションや会場での交流を通じて、みなさん自身のベストな使い方を発見してみてください！

開催概要

@shimizukawa
shimizukawa / README.rst
Last active July 28, 2019 15:19
Sphinx with Markdown !!

Limitations

CommonMark-py supports syntax of CommonMark. So, CommonMark-py doesn't support sphinx/reST role and directives.

References

@shimizukawa
shimizukawa / sphinx-workshop-jus2015.rst
Last active October 26, 2015 08:26
Sphinx ワークショップ 参加要項 in JUS関西 2015/10
  • 日時: 2015/10/31(土) 13時〜17時半
  • 場所: ECCコンピュータ専門学校 2号館2F 2303教室
  • 講師: 清水川(@shimizukawa), 安宅(@kk_Ataka)

オープンソースのドキュメンテーションツール、Sphinxを用いたドキュメント作成について紹介します。Sphinxは文章を構造化しやすいため、分かりやすく、美しいドキュメントを簡単に作ることが出来ます。SphinxはHTML, ePub, PDFなどの複数のドキュメント形式を出力し、ドキュメントはreStructuredText(reST)記法で記載します。 「触ってみようと逡巡している人」や「使おうと思ったけどよく分からない」といった方を対象に、基本的な文法、ビルド、についてハンズオン形式で学んでいきます。

用意するもの

  • Sphinxをインストールする環境
@shimizukawa
shimizukawa / gist:c4fd29b349fba72b2836
Last active September 6, 2015 00:33
Sphinx 英語MLにきた質問 2015/09/06
YAPSYモジュール短縮語(abbreviation)をモジュールページにリンクしたくて、
それを置換(substitution)記法で表現したいと思っています。
以下のように書いたところエラーになりました。
blah blah |yapsy| blah.
.. |yapsy| replace:: `YAPSY <https://yapsy.sourceforge.net/>`_
エラーは以下の内容です。
@shimizukawa
shimizukawa / sphinx-handson-pyconjp2015.rst
Last active October 9, 2015 00:54
Sphinx ハンズオン 参加要項 in PyCon JP 2015

https://pycon.jp/2015/ja/schedule/presentation/6/

オープンソースのドキュメンテーションツール、Sphinxを用いたドキュメント作成について紹介します。Sphinxは文章を構造化しやすいため、分かりやすく、美しいドキュメントを簡単に作ることが出来ます。SphinxはHTML, ePub, PDFなどの複数のドキュメント形式を出力し、ドキュメントはreStructuredText(reST)記法で記載します。 「触ってみようと逡巡している人」や「使おうと思ったけどよく分からない」といった方を対象に、基本的な文法、ビルド、についてハンズオン形式で学んでいきます。

用意するもの

  • Sphinxをインストールする環境
    • OSはWindows, Mac, Ubuntu いずれか
    • Pythonをインストールしておいてください（Python2でも3でもOK）
@shimizukawa
shimizukawa / rds-hosts
Created July 15, 2015 07:59
RDS instance restore from snapshot / delete instance by using ansible (1.9.1 or later)
[rds]
localhost ansible_python_interpreter=~/.venv/bin/python
@shimizukawa
shimizukawa / build-with-envs.bat
Last active August 29, 2015 14:18
sphinx i18n doc build procedure
################################
# ENV variables
set SPHINXINTL_TRANSIFEX_USERNAME=<your-transifex-account-id>
set SPHINXINTL_TRANSIFEX_PASSWORD=<your-transifex-account-password>
set SPHINXINTL_TRANSIFEX_PROJECT_NAME=sphinx-doc-1_3
set SPHINXINTL_LOCALE_DIR=locale
set SPHINXINTL_POT_DIR=_build/gettext
set SPHINX_LANG=ja
set SPHINXOPTS="-D language=%SPHINX_LANG%"