Python3(5)
%350:Python3(5)
%351:【[%340]】の部分コピー
`▼
--------------------------------------------------------------------------------
(0)「tinypy.zip」の解凍フォルダが「(1)①」のようになったので開発環境を
「(1)④」に変更して「(1)②」を継承.
(1)参考資料
①「Tiny_Python試用録(9)」@
「https://www.blogger.com/blog/post/edit/6859150935899261916/4884706954617401594」
②「Python3(4)」@
「https://www.blogger.com/blog/post/edit/6859150935899261916/744789360862341456」
③「https://docs.conda.io/en/latest/miniconda.html」@
④「http://www.tohoho-web.com/python/sphinx.html」
⑤「https://qiita.com/yuta-38/items/730bf91526f92fe0b41a」
/*〔pipとは?(コマンド入力とコマンドを実例で解説)〕*/
⑥「https://qiita.com/mueru/items/2e99832304cf8b89d3ec」
/*〔Pythonとzlib〕*/
⑦「https://www.blogger.com/blog/stats/3months/6859150935899261916」
/*〔「閲覧数」〕*/
・日本 : 102
・ルーマニア: 2
・ウクライナ: 1
・その他 : 12
--------------------------------------------------------------------------------
`▲
%352:「Sphinx」試用例
`▼
--------------------------------------------------------------------------------
(0)【[%351](1)④】の実装を試みました.
(1)参考資料
①「https://www.sphinx-doc.org/ja/1.3/install.html」
②「http://www.tohoho-web.com/python/sphinx.html」
③「https://www.sphinx-doc.org/ja/master/usage/restructuredtext/basics.html」
(2)「(1)①」の紹介
①SphinxはPythonという開発言語で書かれているため、
Python(2.6以降)とSphinxをインストールする必要があります。
②Sphinx関係のパッケージは Python Package Index より入手可能です。
③Gitリポジトリからスナップショットをダウンロードすることもできます。
④他にも
・Mac OS X: MacPortsを利用してインストールします。
・Windows: PythonとSphinxをインストールします。
(3)「(1)②」の紹介(本文からの部分コピー)
①reStructuredText という軽量マークアップ言語を使用します。
②本ページでは、2019年10月20日時点の最新版
Sphinx 2.2.0 をベースに説明します。
③「Sphinxをインストールする」コマンド
--------------------------------------------------------
# yum install -y make
# pip3 install sphinx
--------------------------------------------------------
④「静的コンテンツをドキュメント化する」コマンド
--------------------------------------------------------
$ mkdir work
$ cd work
$ sphinx-quickstart
> Separate source and build directories (y/n) [n]: y
> Project name: テストドキュメント
> Author name(s): 山田太郎
> Project release []: 1.0.0
> Project language [en]: ja
------------------------------------------------------------
(4)「(3)③-④」のような具体例が多数存在.
(5)「(1)③」の紹介
①段落(パラグラフ)
・段落(ref)はreSTドキュメントにおける、もっとも基本的な要素です。
段落は1行以上の空行で区切られた、シンプルなテキストの固まりです。
・Pythonにおいてインデントが重要な意味を持つのと同様、
reSTでもインデントは重要です。同じ段落のすべての行は、
インデントを同じ高さにそろえて、左揃えにしなければなりません。
②インラインマークアップ
・標準のreSTインラインマークアップは極めてシンプルです。
アスタリスク1つ: *テキスト* 強調(イタリック)
アスタリスク2つ: **テキスト** 強い強調(太文字)
バッククオート: ``テキスト`` コードサンプル
・もしも、アスタリスクかバッククオートがテキスト中に使用する場合は、
インラインマークアップの区切り文字と間違ってしまうことがあります。
そのような場合には、バックスラッシュ(訳注:日本語フォントだと円記号)
を使ってエスケープしてください。
③このマークアップにはいくつかの制限があります。
・ネストすることはできません
・中のテキストの最初、もしくは最後にスペースを入れることもできません。
* text* と書くことはできません
・周囲のテキストとは、テキスト以外の文字(スペース、カッコなど)で
区切る必要があります。
もしも空白を空けずに、続けて表記したい場合には、
thisis\ *one*\ word と、バックスラッシュでエスケープしたテキスト
(スペースは表示されません)を使用してください。
(6)とりあえず「(3)③-④」の真似を考えました
③Sphinxのインストール
--------------------------------------------------------
$ yum install -y make
$ pip3 install sphinx
--------------------------------------------------------
④静的コンテンツのドキュメント化
--------------------------------------------------------
$ mkdir work
$ cd work
$ sphinx-quickstart
> Separate source and build directories (y/n) [n]: y
> Project name: テストドキュメント
> Author name(s): 山田太郎
> Project release []: 1.0.0
> Project language [en]: ja
--------------------------------------------------------
⑤「$ mkdir -p./source/test/test1」,
「$ vi./source/test/test1.rst」,
「$ vi./source/test/test2.rst」.
⑥「./index.rst」(?)
「./test1.rst」/*〔#test1.py〕*/,
「./test2.rst」/*〔#test2.py〕*/.
(7)「https://www.sphinx-doc.org/ja/master/usage/configuration.html」
①設定ディレクトリ には必ず conf.py が含まれています。
このファイルは "ビルド設定ファイル" と呼ばれていて、
Sphinxの入出力の動作をカスタマイズするのに必要な
(ほとんど)すべての設定はこのファイルに含まれています。
②この設定ファイルはPythonのプログラムとして書かれています。
設定ファイルは、ビルド時にPythonコードとして実行される
(設定ファイルが含まれる フォルダをカレントディレクトリに設定し、
execfile() を使用して呼び出される)ので、
任意の複雑なコードを記述できます。
③Sphinxが読み込む際には単純にファイルの中の
名前空間に定義されている名前を使うことで、設定を読み込みます
④詳細に説明するにあたっての注意点を列挙します。
・特別に指定されていない場合には、設定値は文字列型になります。
また、指定されていない場合のデフォルト値は空文字列です。
・"完全限定名(FQN)"という用語は、
モジュール内のインポート可能なPythonオブジェクトをあらわす名前です。
例えば、 "sphinx.builders.Builder" という完全限定名は、
sphinx.builders モジュールにある Builder クラスを意味します
--------------------------------------------------------------------------------
`▲作業中
%359:EOF(@L4J)
コメント
コメントを投稿