remarkdown を巡る冒険 (原題: remarkdown versus Sphinx) - Hack like a rolling stone
docutils はある形式の文書を別の形式に変換するフレームワークです。 このフレームワークを利用して rst2html や rst2latex などが提供されています。 しかし、docutils が標準で対応している入力形式は reST 形式に限られているので、 実際には reST 変換用のライブラリとして捉えられていました。 markdown 黄金時代 docutils や Sphinx の周囲では reST を中心としてドキュメントが記述されていますが、 2014年現在、軽量マークアップ言語の主流の座は markdown であると言っても過言ではないでしょう。 flavor が乱立していたり、拡張性に乏しかったり、困ったら HTML で書き下してあったりと、 記述能力が十分とはいえない markdown ですが、github を初めてとして様々な場所で用いられています。 4月1日は
ふだん Markdown を書く技術者のための reStructuredText 文法まとめ
ふだんは Markdown を書いていて、稀に reStructuredText を書く必要がある技術者（私です）のための reStructuredText 文法まとめです。 reStructuredText のすべてを網羅するのではなく、あくまで「 Markdown にある機能を reStructuredText で使いたい」という状況を想定した上での簡易的なまとめです。 reStructuredText の詳細を本格的に学びたい場合は次の 2 つのページを参照することをおすすめします。 reStructuredText Primer — Sphinx documentation reStructuredText 「 Markdown なら書き方がわかっているんだけど、 reStructuredText でどう書けばいいかわからないので、いちいち検索してしまう」という方のお役に立てば幸い
New features of autodoc in Sphinx-2.4 - Hack like a rolling stone
Today, I released Sphinx-2.4.0, now available on the Python package index at https://pypi.org/project/Sphinx/. It includes 18 new features and 23 bugfixes. For the full changelog, go to http://www.sphinx-doc.org/en/master/changes.html. In this article, I'd like to introduce you to new features of autodoc. Support type annotations for variables Until now, autodoc did not document type annotations f
Sphinx-2.4 で進化した型機能を使おう - Qiita
先ほど Sphinx-2.4.0 をリリースしました。 Sphinx は 2ヶ月ごとの定期リリースを目指しているので、大体予定通りのリリースです。 2.4.0 では autodoc まわりの機能が大きく改善されました。この記事ではその改善点についてまとめたいと思います。 変数アノテーションへの対応 autodoc: Support type annotations for variables #7051: autodoc: Support instance variables without defaults (PEP-526) これまで、コード内の変数アノテーションはドキュメント化されていなかったのですが、2.4 からはドキュメントに出力されるようになりました。 いまや型情報は規模の大きいプログラムを書くのに欠かせない情報となっています。型情報をアノテーションすることは、あなたと開発チー
画面コピーを含む操作手順書をあっという間に作る - Qiita
はじめに 本職が業務用海外アプリの販社のアプリケーションサポートなので、ユーザーや開発元とのやり取りで不具合が出る操作手順を画面キャプチャして手順書を残すことがよくあります。 たいていはWinshotで特定のフォルダに一旦、画面コピーをとにかく集めてからExcelに張り付けていくことになるのですがまあとにかくめんどくさい。 操作を動画に落とすのもありですが、どうしても冗長だしファイルサイズは過大だしでこれも気に入らない。 ところが、クリップボードにある画像をQiitaの編集画面に張り付けるとPNG画像としてアップロードしてくれるというのを読んだときにピピっと(死語)来た訳です。 さすがにQiitaを作業用に使うわけにもいかないので、Knowledgeの編集画面にペーストするとQiita同様にPNG画像がアップロードされたので、これを下書き＆画像収集に使用してSphinxで清書できないかと考
個人的なSphinx 利用術メモ - Qiita
この記事では Sphinx を普段から使用している者が個人的に使えそうな書き方、および観点を記述します。PC関連のユーザマニュアルの書く目線の記述が多めです。 Sphinx 概要を三行で Sphinx は構造化した文章作成が得意なドキュメントビルダーです。 reStructuredText という形式のテキストファイルから、 make html または make latexpdf などのコマンド一つ実行することで、読みやすい html や pdf を簡単に作ることができます。 よく使う書き方 Sphinx ではApiドキュメントなど Code が途中で入った文章、キャプチャ画像が多いマニュアルは構造的な文章は向いています。故に、繰り返す部分を予め定義しておいて使いまわす、など工夫をすると書きやすいし読みやすいです。以下、個人的に使う書き方をいくつか紹介します。 .rst のセクションのパタ
Sphinxの表をExcelで管理する - Qiita
なんだかんだいって、Excelで管理することになるのが世の習わしです。 Excelで管理されたデータを他で使うために、CSVにすることが多いと思います。 CSVにすると、Sphinxの表がつくれます。 ExcelをCSVに変換する Excel CSV I/Oアドインというとても便利なアドインがあります。 http://fnya.cocolog-nifty.com/blog/2012/03/excel-csv-io-ex.html 自動化ではありませんが、どのExcelファイルでも使えるという利点があります。 使い方は、開いたExcelファイルで、Excel CSV I/Oのエクスポートボタンを押すだけです。 ダイアログが出てきますが、基本、そのままエクスポートです。 Sphinxの表をCSVで扱う Sphinxでは表のデータをCSVファイルから取り込むことができます。 そこで、こんなふうに
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
