Hatena Blog Tags
はてなブログ トップ
reStructuredText
このタグでブログを書く
言葉の解説
ネットで話題
関連ブログ

reStructuredText

(コンピュータ)
【りすとらくちゅあどてきすと】

軽量マークアップ言語。

このタグの解説についてこの解説文は、すでに終了したサービス「はてなキーワード」内で有志のユーザーが作成・編集した内容に基づいています。その正確性や網羅性をはてなが保証するものではありません。問題のある記述を発見した場合には、お問い合わせフォームよりご連絡ください。
てくてっく•2年前

軽量マークアップ言語の特徴比較まとめ

マークアップ言語とは マークアップ言語とは、PCを用いた文書の作成において、組版(レイアウト)のために図表の位置や章立てなどの情報を文書ファイルに付加するための形式言語(文法、またはマークの規則)です。 元来は英語圏の出版業界において、原稿に組版情報を書き加えていく作業をmarking upと呼んでいたことに由来するようです。[wikipedia-markup] 代表的なマークアップ言語には、以下のようなものがあります。 HTML ウェブブラウザ上で、意図したレイアウトで文書を表示する用途に使われている。 XML HTMLと同様にウェブブラウザで表示する文書のレイアウト指定の他に、汎用的にデー…

#Markdown#reStructuredText#asciidoc#textile#Wiki

ネットで話題

もっと見る
149ブックマークはやわかり reStructuredText本マークアップ記法の完全な詳細は reStructuredText のページに示されています。このテキストは、覚書としての性格の文書です。 "(詳細)" というリンクを辿ると reStructuredText 仕様書を参照できます。 ただし、相対リンクとなっていますので、リンク切れの場合は、 原版の "Quick reStructuredText" から参照してく...www.planewave.org
127ブックマーク技術ドキュメンテーションのためのreStructuredTextとMarkdownを比較する | POSTDpostd.cc
64ブックマークreStructuredTextMarkup Syntax and Parser Component of Docutils Date: 2024-10-26 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 s...docutils.sourceforge.io
60ブックマークReStructuredText 入門以下の文章中に "(quickref)" という形式のリンクがあります。これは、 Quick reStructuredText ユーザリファレンスへの相対リンクです。このリンクが 切れている場合は、 オンラインのクイックリファレンス を参照してください。 構造 まずはじめに、"Structured Text" （構造化されたテキスト）という呼び方には、 い...www.planewave.org
51ブックマークreStructuredText(reST)をEmacsで書く際のまとめ - YAMAGUCHI::weblogymotongpoo.hatenablog.com
47ブックマークQuick reStructuredTextQuick reStructuredText https://docutils.sourceforge.io/docs/user/rst/quickref.html Being a cheat-sheet for reStructuredText Updated $Date: 2022-01-29 23:26:10 +0100 (Sa, 29. Jän 2022) $ Copyright: This document has been placed in the public domain. The full details of the markup may be found on t...docutils.sourceforge.io
39ブックマークreStructuredText - WikipediareStructuredText は、軽量マークアップ言語のひとつ。ソースコードの状態で高い可読性を持つように設計されている。reStructuredText パーサは、テキスト処理フレームワークである Docutils のコンポーネントのひとつであり、Python で実装されている。 reStructuredText は、RST、reST、ReST と略されることもある。ja.wikipedia.org
33ブックマークOnline reStructuredText editorFork me on GitHub Theme: Basic Naturerst.ninjs.org
30ブックマークreStructuredText入門 — Sphinx v1.0 (hg) documentationreStructuredText入門¶ このセクションは、reStructuredText(reST)の考え方や文法についての短いイントロダクションです。Sphinxユーザがドキュメントを作成するために十分な情報を提供します。reSTはシンプルに設計された、控えめなマークアップ言語ですので、理解するのにそれほど時間はかからないでしょう。 段落(パ...sphinx.shibu.jp

関連ブログ

サポンテ 勉強ノート•4年前

reStructuredText：CotEditor のファイルドロップ設定

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

#reStructuredText#CotEditor
サポンテ 勉強ノート•7年前

restructuredText の表のセルの中で改行する

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

#reStructuredText#table#改行
nikkie-ftnextの日記•6ヶ月前

reStructuredTextの画像（figureやimageディレクティブ）は、URLを設定してリンクにできたのか！（targetオプションを知りました）

Sphinx関係の小ネタです。 初めて知って、ちょっと感動しました。 目次 目次 reStructuredTextで画像を表示 targetというオプションでリンクにできる！ imageディレクティブ figureディレクティブ 終わりに reStructuredTextで画像を表示 『Sphinxをはじめよう 第3版』 A.10より reSTで画像を埋め込むにはfigureディレクティブ インライン画像はimageディレクティブ これらはdocutilsのディレクティブです。 画像のサイズはオプションで変えられます。 height width scale サイズのオプションは、tk0miya…

#Sphinx#reStructuredText#画像#リンク
nikkie-ftnextの日記•2年前

reStructuredTextとリンクを作るマークアップ（全部一緒だと思っていたのですが、細かい意味の違いがあった…だと…）

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

#reStructuredText#ハイパーリンク#Sphinx
エンターテイメント！！•6ヶ月前

【翻訳＋意訳・要約】Docs as Code: テクニカルライターのためのベストガイド

※本記事は、ChatGPTによる意訳+翻訳を活用し、レイアウト調整したものです。 ※感想は、オリジナルです。 原文 意訳+要約 Docs as Code: テクニカルライターのためのベストガイド Docs as Codeとは？ 主な利点 実践のステップ 成功への鍵 ChatGPTへのQA Ｑ：MarkdownとreStructuredText、それぞれの利点は何ですか？ Markdownの利点 reStructuredTextの利点 まとめ Ｑ：「Docs as Code」を既存のプロジェクトに適用するには、どのようにすればいいでしょうか？ 1. 現状の把握と計画の立案 2. ツールと技術の選…

偏った言語信者の垂れ流し•7ヶ月前

Pyodide上でdocutilsを動かしてみる

docutilsはreStructuredTextをPythonで扱うためのモジュール。 Pyodide上でdocutilsを動かせば、ブラウザ上だけでreStructuredTextを扱えるかなと思って試していました。 コード pyodide-docutils.html: <!doctype html> <html> <head> <script src="https://cdn.jsdelivr.net/pyodide/v0.24.1/full/pyodide.js"></script> <link href="https://cdn.jsdelivr.net/npm/bootstrap@…

プログラムでおかえしできるかな•8ヶ月前

Sphinxでdocstringからクラスごとの仕様書を生成【Python】

Python のソースから仕様書を生成する方法を紹介します。 仕様書は、クラスごとに分けたウェブページとして生成します。 生成には、Sphinx を使用します。 Sphinx の拡張機能 autodoc、sphinx-immaterial を使用して簡単に実現します。

仲宗根淳平のプログラミング勉強ノート•1年前

django-cognito-jwtのコードリーディング1

github.com django-cognito-jwtのリポジトリを読みながら学んだことを書いていきます。

Python転職初心者向けエンジニアリングブログ•1年前

Pythonで動的なドキュメント生成ツール「ドゥラメンテ」を使ってみよう

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