行政文書はMarkdownで管理できるか｜Hal Seki
（9月3日追記）元のタイトルは「行政文章はMarkdownで管理できるか」でしたが、ここで言っているのは「文章」ではなく、「文書」だろう、というご指摘をいただき、本文も含め訂正させていただきました。（追記終わり） 先日下記のTweetをしたところ、多くの人からコメントをいただきました。 行政文章のMarkdown化、進めていきたい。公開時だけでなく、普段からMarkdownでやりとりできるといいんだけどな。Wordを使って文章作ってる人をターゲットにしたMarkdownエディタを作ってみたい。 HackMDでもまだ難しいイメージ。実務に寄せていく必要がある。https://t.co/3iVDjXVHcQ — Hal Seki (@hal_sk) August 31, 2021 賛同の意見が多かったのですが、下記のような懸念点もいただきました。 ・編集する側も見る側も大変になる。何故やる必要
Pythonのdocstring（ドキュメンテーション文字列）の書き方 | note.nkmk.me
Pythonでは、関数やクラスなどの定義の先頭に記述された文字列が、docstring（ドックストリング、ドキュメンテーション文字列）として扱われる。 IDEやエディタによってはキーボードショートカットでdocstringを表示させて内容を確認できる。またPyCharmなどでは、docstringの情報をもとに静的解析して警告を出してくれる。
PythonパッケージをPyPIにアップロードする際にMarkdownをreSTに変換 - Steel Dragon 14106
PythonパッケージをPyPIにアップロードする際にMarkdownをreSTに変換 By raimon, 2018-01-30(火), in category Python MarkdownフォーマットではHTML描画されない問題 Pythonパッケージの開発もGitHubが使われるケースが増えている。それに伴って、パッケージのドキュメントもMarkdownフォーマットが採用されるケースも散見される。 ただし、MarkdownフォーマットでPyPIサーバーにアップロードすると、Web UIではHTML描画されないため、ユーザーフレンドリーではない。 そこで、Pythonパッケージの新しいバージョンをPyPIサーバーにアップロードする際に、オンデマンドでreStructuredText（以降「reST」）フォーマットにオンデマンドで変換してやると、いい感じにWeb UIでもHTML描画さ
Use Markdown README's in Python modules (Example)
If, like me, you regularly use Markdown to give your GitHub projects nice pretty README's, but are trying to submit your new swanky Python module to the Python Package Index, you may have hit a bit of a snag. To get your nicely formatted README on your module's PyPi page, you need to use reStructuredTxt. Now you could admit defeat and change your README, or you could do this: Install Pandoc Instal
Sphinx のメンテナになって一年が経過した話 - Hack like a rolling stone
クリスマスが過ぎてから始まる Sphinx アドベントカレンダーへようこそ (嘘) Sphinx 大型連載第二夜です。 タイトルにある通り、Sphinx のメンテナ活動をして一年が過ぎたので、その話をします。 OSS 開発者のひとつのサンプルケースとして、何かの参考になれば幸いです。 Sphinx のメンテナ活動をはじめました 去年の 12月から Sphinx のメンテナ活動をはじめました。 Python のリリースマネージャ活動が忙しかったからか原作者の Georg の活動が鈍り、 また、その後を継いだ清水川さんも忙しくて身動きが取れなくなっていたことから、 コミット権をもらっていたことだし、パートタイムで手伝うかと思ったことがきっかけでした。 以前からコミット権は持っていたものの、一切メンテナとしての活動をしていなかったので、 徐々にチケットが溜まっていく様子に後ろめたくなったのかもし
GitHub - pypa/sampleproject: A sample project that exists for PyPUG's "Tutorial on Packaging and Distributing Projects"
A sample project that exists as an aid to the Python Packaging User Guide's Tutorial on Packaging and Distributing Projects. This project does not aim to cover best practices for Python project development as a whole. For example, it does not provide guidance or tool recommendations for version control, documentation, or testing. The source for this project is available here. The metadata for a Py
ドキュメントの継続的な開発方法 | IIJ Engineers Blog
私はソフトウェア開発を主体とするエンジニアで、 クラウドサービスの開発・運用 分散処理技術の検証とサービス利用の検討 社内の開発支援環境の開発・運用 などの業務に従事していますが、今回の記事は業務とは直接的な関係は無く、私が会社で勝手自発的に行っている取り組みについて書きたいと思います。 昨今、インターネットは生活に深く浸透し、クラウドサービスを利用することで安く簡単にWebサービスを開発、公開できるようになりました。Web技術の進化や流行の移り変りも非常に激しく、既存サービスの機能追加や新規サービスの開発は頻繁に行われています。それは弊社も例外ではありません。 このような開発の現場では、リーンソフトウェア開発への取り組みなど開発手法の最適化が積極的に行われ、様々なベストプラクティスが生みだされています。それらのベストプラクティスには、 継続的インテグレーション や 継続的デプロイメント
Swift header documentation in Xcode 7
Update: There’s now a book! Quick Help offers concise in-line reference docs for symbols, build settings, and interface objects. Want to check a symbol’s type? Quick Help it. Need to look up parameters? Quick Help to the rescue. Add Quick Help to annotate your code and create custom information that displays via pop-ups (option-click symbols) and the Quick Help inspector (View > Utilities > Show Q
SphinxをMarkdownで使い隊
Sphinxを、MercurialとPandocを組み合わせて Markdown記法で運用できるようにしたお話。
国際化 — Sphinx 1.4.4 ドキュメント
Sphinxでは、ナビゲーションバーなどの文字列を各国語にする機能を提供していましたが、 文章 そのものを翻訳する機能を提供します。細かい設定については 国際化のオプション を参照してください。 Sphinx 国際化について¶ gettext [1] は国際化とローカル化の手段として、よく使用されている方法です。プログラム中で使用されるメッセージと、翻訳文字列の対応表を使って置き換えてきます。Sphinxはこの機能を使って、ドキュメント全体を翻訳していきます。 まず最初に、プロジェクトのメンテナーはすべての翻訳文字列を集めてくる必要があります(これを メッセージ と呼ぶ)。これを翻訳者に渡します。Sphinxでは、 sphinx-build -b gettext を実行して、これを行います。 すべてdoctreeの要素は、それぞれがメッセージとなります。巨大なパラグラフは原文のまま残ります
Swift Documentation
Written by Nate Cook & Mattt July 11th, 2018 (revised) This article has been translated into: 中文 Code structure and organization is a matter of pride for developers. Clear and consistent code signifies clear and consistent thought. Even though the compiler lacks a discerning palate when it comes to naming, whitespace, or documentation, it makes all the difference for human collaborators. This week
Pelican って何？
「Pelican」は、Python製静的サイトジェネレータです。 「reStructuredText」「Markdown」「AsciiDoc」といったマークアップ言語を用いて、 好きなエディタでコンテンツを記載し、作成したコンテンツを付属のCLIツールで手軽に公開する事ができます。 似たようなツールとして、Ruby製の Jekyll や Octopress、 Middlemanが有名ですが、なんとなく「Python製の静的サイトジェネレーターが無いかなー」と探していたところ出会ったのがPelicanでした。 Pelicanと出会った瞬間 触ってみて、Pelicanの良い所は「Pythonさえあれば動く！（ぴゅあぱいそん！）」「シンプル！」「動作が軽快！」ってところなのかもしれませんが、まぁ、とりあえず 名前がかっこいい って事で使い始めました。 （ロゴは適当ですが・・・） ちなみに「Pel
3.6.1. Restructured Text (reST) and Sphinx CheatSheet — openalea.doc v0.8.0 documentation
See also This documentation is based based upon documentation found in: Sphinx Docutils Note Sphinx code is written in reST. Nonetheless, sphinx adds many additional directives on top of the reST syntax. Therefore sphinx code may not be fully compatible with reST. 3.6.2.1. Introduction¶ reStructuredText is an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser system. It
静的ファイル生成ブログツール6選 | Act as Professional
octopress [ut url=”http://octopress.org/” class=”aligncenter”] Octopress 初期設定のままで、スマートフォンでも閲覧できるレスポンシブデザインされたテンプレートが付属されているoctopressです。内部コアにjekyllが使われて拡張されているRuby製の静的ブログエンジンです。 octopressを利用してブログを書いている日本人技術者も多数いるようで、参考になる情報があるのも魅力の1つです。 Pelican [ut url=”http://docs.getpelican.com/” class=”aligncenter”] getpelican/pelican · GitHub Python製の静的ブログエンジンです。octopress並に一通りの機能が実装されていますし、ソースコードのメンテもおこなわれていること
Redmine で reStructuredText を使う方法
我々BeProudのRedmineのWikiやチケットの説明文やチケットのコメント文にはReStructuredTextを使っている。 RedmineのデフォルトのTextileはPythonが好きな弊社で使うのは以ての外。なので、ReSTを使うようにした。 そして、生のReSTしか使わなければ、出来ることが少ないので、blockdiagや、コードの構文ハイライト（Pygments) を使っている。 Redmine はテキストフォマッターを入れ換えるように作られている。プラグインを入れるとWiki やチケットの内容のフォーマットを変えることができます。BeProud では Redmine reStructuredText Formatter の RbST/docutils ブランチを使っている。 http://glacialis.postmodo.com/posts/zyd1ig インスト
ReStructuredText 文法まとめ - secretbase.log
Sphinxで使う軽量マークアップ言語 ReStructuredText で役立ちそうなサイトをまとめてみました。(ReStructedText基礎文法最速マスターがありそうで無かった) 文法 サイト名 説明 ReStructuredText 入門 ReStructuredText Primerの日本語訳 はやわかり reStructuredText プレーンテキストと変換結果の例がわかりやすい reStructuredText Markup Specification rstの詳細な仕様。チュートリアルや入門ではない reStructuredText入門 :: ドキュメンテーションツール スフィンクス Sphinx-users.jp よく使う記法。入門 Tips サイト名 説明 reSTおよびSphinxで文章を書く際のtips - そこはかとなく書くよ。 論文っぽい文章を書くときのti
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Markdownもはじめよう
http://www.gembook.org/docutils-patch.html
reStructuredText - Wikipedia