The Power of Sphinx: Integrating Jinja with RST
The Power of Sphinx: Integrating Jinja with RST¶ Sphinx is a super powerful tool. This has its upsides and downsides. One of the major downsides is that historically it has been built as a framework that allows users to do just about anything. This is great, except it also means that a lot of the specific value out of the modular design hasn’t been documented or made explicit to users. I’m hoping
Flake8: Your Tool For Style Guide Enforcement — flake8 7.0.0 documentation
Note It is very important to install Flake8 on the correct version of Python for your needs. If you want Flake8 to properly parse new language features in Python 3.5 (for example), you need it to be installed on 3.5 for Flake8 to understand those features. In many ways, Flake8 is tied to the version of Python on which it runs.
reStructuredText
Markup Syntax and Parser Component of Docutils Date: 2024-08-02 reStructuredText is an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser system. It is useful for in-line program documentation (such as Python docstrings), for quickly creating simple web pages, and for standalone documents. reStructuredText is designed for extensibility for specific application domains. T
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
Vim - previmとrst2htmlでreStructuredTextをリアルタイムプレビューしながら編集する - ぼっち勉強会
previmでreStructuredTextをサポートしました。 ただし外部コマンド必須です。 previmとは Vim - 依存ツールなしにMarkdownプレビューできるprevimプラグインを作った reStructuredTextの環境要件 rst2html.pyというコマンドが必要です。 pip等でdocutilsを入れると使えるようになります。 % pip install docutils % rst2html.py --version rst2html.py (Docutils 0.12 [release], Python 2.7.5, on darwin) もちろんMarkdownやtextileの場合はこれまで通り不要です。 使い方 Markdownと基本的に同じですので、上述の記事かREADMEかヘルプを参照してください。 filetypeがrstの場合に実行出来ます
表を書きたい — Sphinx逆引き辞典 v0.0.1 documentation
表を書きたい¶ 一番最初に説明されている–や+を使って書くグリッドテーブル方式は確かにテキストファイルを見たときに分かりやすいのですが、幅を合わせる必要があり、書くのが非常に大変です。特に日本語フォントが混じると文字数がずれることがあります。 CSVテーブルやListテーブルを使った方が楽です。 まずはcsvテーブルです。”,”で区切ることでテーブルを書きます。csv-table::と本文の間は一行空けます。これはlist-tableも同様です。 .. csv-table:: Frozen Delights! "Treat", "Quantity", "Description" "Albatross", 2.99, "On a stick!" "Crunchy Frog", 1.49, "If we took the bones out, it wouldn't be crunchy, n
Pandoc - index
If you need to convert files from one markup format into another, pandoc is your swiss-army knife. Pandoc can convert between the following formats: (← = conversion from; → = conversion to; ↔︎ = conversion from and to) Lightweight markup formats ↔︎ Markdown (including CommonMark and GitHub-flavored Markdown) ↔︎ reStructuredText → AsciiDoc ↔︎ Emacs Org-Mode ↔︎ Emacs Muse ↔︎ Textile → Markua ← txt2t
restview - A ReStructuredText viewer
About A viewer for ReStructuredText documents that renders them on the fly. Pass the name of a ReStructuredText document to restview, and it will launch a web server on localhost:random-port and open a web browser. It will also watch for changes in that file and automatically reload and rerender it. This is very convenient for previewing a document while you're editing it. You can also pass the na
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
kernel-doc HOWTO — kernel-doc HOWTO 4.7.0 documentation
GitHub - rstcheck/rstcheck: Checks syntax of reStructuredText and code blocks nested within it
rst-cheatsheet/rst-cheatsheet.rst at master · ralsina/rst-cheatsheet
parboiled2/README.rst at release-2.1 · sirthias/parboiled2 · GitHub
riko/README.rst at master · nerevu/riko
Markdown Documentation with Sphinx | When Penguins Can Fly…
GitHub - gu-fan/riv.vim: Notes and Wiki with rst.
GitHub - kenichiro22/rst2confluence: Convert restructuredText to Confluence style wiki.