reStructuredText

はじめに テキストエディタ CotEditor では、エディタ画面にファイルをドラッグ&ドロップすると相対パスを自動で生成してくれる便利な機能があります。 reStructuredText なら :doc: とか .. image:: とか入力して欲しい。ということで設定してみます。 :doc: これは、相対パスを入力して欲しいものの、拡張子は余分です。<<<RELATIVE-PATH-NOSUFFIX>>> のようなものがあれば良かったのですが。 拡張子は「不要だけど、あっても良い」のでしたっけ？「あってはならない」のでしたっけ？ちょっと失念してしまいました。 :doc:`<<<FILENA…

はじめに restructuredText にはいろいろな表の書き方がありますが、セル内改行方法について意外とまとまったものがなかったので記します。 確認 VS Code の ReStructured Text Previewer v2.0.0 で確認しました。 Grid Table 編 先頭に "|" をつける。 参考 +----------+----------+----------+ | Header 1 | Header 2 | Header 3 | +==========+==========+==========+ | | Item 1 | | | | | Item 2 | | |…

はじめに ずっとずっと、一緒だと思っていた。1 nikkieです。 reStructuredText（reST）にはいろんなマークアップがありますよね。 リンクを作りたいときは `Link text <https://domain.invalid/>`_ と書いてきた2のですが、これが何をしているか何も分かっていなかったことをこのたび痛感しました。 一体何があったのか、共有していきます。 目次 はじめに 目次 reSTでリンクを作る書き方 きっかけ：アンダースコア2つのreSTのリンク！？ 結論：リンクの記法まとめ 『Sphinxをはじめよう』付録Aより ハイパーリンク記法 埋め込みURL記法…

Godotのドキュメントの翻訳に少しずつ参加しています。GodotのドキュメントはreStructuredTextというマークアップテキストが採用されています。はじめて使うので正しく動くかや空白の入れ方が結構シビアで何かと不安なので、手元の環境でプレビューできる環境を構築してみました。 目次 目次 ブログの環境 前準備 Pythonとpipのバージョン確認 pipがエラーになる場合 Sphinxのインストール reStructuredTextを扱うためのプロジェクトを作成する VSCodeを設定する reStructuredTextをプレビューする まとめ 関連URL ブログの環境 この記事は…

Pythonで動的なドキュメント生成ツール「ドゥラメンテ」を使ってみよう ドゥラメンテ（Dokumente）は、Pythonで動的なドキュメントを生成するためのツールです。このツールを使用すると、コードとドキュメントを統合して、コードの変更に応じてドキュメントを自動的に更新することができます。ドゥラメンテは、開発者やチームが迅速かつ効率的にドキュメントを管理し、プロジェクトの可読性と保守性を向上させることができます。 ドゥラメンテの特徴 ドゥラメンテの主な特徴は以下の通りです。 動的なドキュメント生成: ドゥラメンテはPythonのコードと統合されており、コードの変更に応じてドキュメントを自動…

個人的に興味があって触る機会があったので、公式サイトで勉強しながらまとめた。 typelevel.org Laikaとは Laikaを試す Laikaがデフォルトで対応しているフォーマット ExtensionBundle Laikaと副作用 Laikaをsbtプラグインから利用する 応用 Laikaとは Laika*1とは、Scalaで記述された静的サイトジェネレータ。 LaikaのサイトもLaikaで生成されている。 高度にモジュール化されているため、例えばプログラム上から変換処理だけ呼び出すといったこともできる。このため一部だけ拡張させるといったことが容易にできる。 Markdown入力に…

しばしば、LaTeX を使うことの意義として「数式があるから」が挙げられます。これは実際、LaTeX で数式を書くことで綺麗にレンダリングされるからです。TeX を開発した Knuth は数学者であり、数式に関する写植にはこだわったことでしょう。 かと言って「LaTeX は数式のためだけに利用されるのか」と言う疑問に単刀直入に答えるのであれば “No” です。LaTeX は数式を記述するためのみに利用されるべきツールではありません。 また、「MS Word で良いのでは？」と言う声（Twitter での声）も聞かれますが、数式以外にも LaTeX にはさまざまなメリットがあります。 本記事では…

はじめに 東海林さん、かっこよかった〜。うぇるこましてきたnikkieです。 すっかり遅くなってしまいましたが、11/30(木)のGuido氏インタラクティブ記念講演会を記事にします。 目次 はじめに 目次 Guido氏インタラクティブ記念講演会 Guidoさん！俺の作った sphinx-new-tab-link を見てください！！ 英語発表原稿 日本語版 Guidoさんのコメント、天にものぼるような心地 終わりに P.S. 発表準備ログ Guido氏インタラクティブ記念講演会 C＆C賞の受賞で来日されたGuido氏（Pythonの生みの親）の記念講演会です。 インタラクティブを冠する通り、G…

Webサイトやアプリをつくるために必要な規格をまとめた。

gigazine.net ⇧ amazing... 気になるのは、 ホースラディッシュ（英: horseradish、学名: Armoracia rusticana）は、アブラナ科の耐寒性の多年草。和名はセイヨウワサビ（西洋山葵）。 ホースラディッシュ - Wikipedia ⇧「ホースラディッシュ」の和名が「セイヨウワサビ」なんだけど、「わさび」と同様の効果は無いのかね？ ソースコードのステップ数を得るのはclocを使うのが良さ気らしい Eclipseとかで開発することが多かったので、 github.com ⇧ を使ってたことがあったのですが、今回は、シェルスクリプトのステップ数を取得したい…

RISC-Vのベクトル命令一覧を作成するときに使った、wavedromの命令フォーマット表記が奇麗で気に入っているので、スカラ命令の命令一覧ページも同じように改変することを検討している。 msyksphinz-self.github.io 各命令の定義のページは、RestructuredTextを使って書いているのだが、これをAsciidocに変換したうえで命令フォーマットの表記を変えていく。 wavedromで記述された各命令の定義が一覧になっていればありがたいのだが、探しても見つからなかったので一から変換している。 === lui load upper immediate. Encodin…

オープンソースで開発しているPythonの将棋ライブラリcshogiにドキュメントを追加した。tadaoyamaoka.github.io今まで、READMEと強い将棋ソフトの創り方に主要な部分のみ説明を記載しているくらいで、詳細なドキュメントがなかった。今回、全体的にコードにdocstringを追加して、Sphinx+autodocでドキュメントを生成した。 GPT4でdocstringを生成 docstringの内容は、GPT4を活用して記述した。 GPT4は、ソースの意図をくみ取って、自分で書くよりも適切な説明文を生成してくれた。 GPT4は、将棋の知識や、USIプロトコルに関する知識も…