Windowsへのインストール
Windowsへのインストール¶ Pythonのインストール¶ Windowsは、標準でPythonがインストールされていませんので、Pythonのインストールから説明します。 Pythonをインストールする為のPythonディストリビューションやツールにはPyenv、 Anaconda、ActivePython、IronPython等、他にもいくつかありますが、ここでは公式のPythonインストーラを使います。 Pythonの環境構築に慣れている方であればどのディストリビューションを選択しても問題無いと思いますが、Pythonに慣れていない方は複数のPythonのインストールを避け、公式のPythonだけをインストールして下さい。 また、Pythonは2系と3系がありますがPython2はサポートが終了しています。公式の Python3 の最新版 [1] をインストールしましょう。以降は
プロジェクトを作る
プロジェクトを作る¶ Sphinxでドキュメントを作成するためには、まず「プロジェクト」を作る必要があります。プロジェクトはコマンドラインで作成しますので、Windowsの場合はコマンドプロンプト、MacやLinuxの場合はTerminal(仮想端末)を起動させます。 プロジェクトは、いくつかの設定ファイルなどが配置された、ドキュメントを保存するための専用ディレクトリです。配置するファイルなどは、Sphinxに含まれる「sphinx-quickstart」というコマンドで作成します。 sphinx-quickstart¶ 何もオプションを付けないと対話モードになり、 -q オプションを付けると非対話モードでプロジェクトが作成できます。ここでは非対話モードを紹介します。 プロジェクト名の指定: -p ドキュメントの製作者(Author name(s))の指定: -a プロジェクトのバージョン
macOS と Linux(Ubuntu)へのインストール
macOS と Linux(Ubuntu)へのインストール¶ macOS と Linux(Ubuntu)へのインストールは大きく分けると OS のパッケージ管理ツールからインストールする方法と、 Python のパッケージ管理ツールを使ってインストールする方法があります。 ここでは Ubuntu のパッケージ管理コマンド apt を使った方法と、macOS、Linux OS 共通のインストール方法として Python 標準のパッケージ管理コマンド pip を使った方法を紹介します。 パッケージ管理ツールを利用したインストール(Ubuntu)¶ UbuntuなどのDebian系のOSの場合は、以下のコマンドを使ってインストールすることができます。 pip を使ってインストールする(macOS, UNIX & Linuxディストリビューション共通)¶ macOS や Linux ディストリビュ
ページ内の目次を作りたい
ページ内の目次を作りたい¶ contents を使います。 contents はページ内のセクションに対してリンクを作ります。以下のオプションが使えます。 文字列目次のタイトルを指定します。必ず他のオプションより先か、 contents ディレクティブと同じ行に書いてください。 :depth: <数値>目次に含めるセクションの深さを指定します。指定がない場合はすべてのセクションを目次に含めます。 :local:このディレクティブ以降にあるセクションだけを目次に含めます。指定がない場合はページ内のセクションをすべて含む目次を作ります。 また、このオプションを指定すると目次のタイトルがなくなりますので、別途指定してください。 :backlinks:セクションから目次に戻るリンク(バックリンク)に対しての動作を決めます。以下の引数を持ちます。 引数 動作
ドキュメントの構築
ドキュメントの構築¶ ドキュメントのヘルパーとガイドラインを提供すると、読者と作成者の両方の仕事を簡単に改善することができます。そのために、前節で学んできたことを活用していきます。 ドキュメント作成者の視点から考えると、ガイドと一緒に再利用可能なテンプレート集が提供され、それをプロジェクトの中でいつどのように使用するかという説明があると、この目標は達成できます。これをドキュメントポートフォリオと呼びます。 ドキュメント読者の視点から考えると、どのようなドキュメントが提供されるのかという展望が提供されると、楽にドキュメントを読むことができるようになりますし、必要なドキュメントを効率良く探して利用できるようになります。 ポートフォリオの構築¶ ソフトウェア開発のプロジェクトの中で作られるドキュメントには、ソースコードを直接参照するような低レベルなドキュメントから、アプリケーションの概要を伝える
技術文書を書くための７つのルール
技術文書を書くための７つのルール¶ さまざまな面から見て、良いドキュメントを書くことは、良いコードを書くよりも簡単です。多くの開発者はドキュメントを書くのはとても難しいことであると考えていますが、いくつかのシンプルなルールに従うだけで、本当に簡単になります。 ここでお話しするのは、ポエムの本を書くための方法ではなく、プログラムの設計やAPI、コードベースを作り上げる上で、必要となるものを理解するための包括的なテキストを書くための方法になります。 全ての開発者はそのようなテキストを書くことができます。本節ではあらゆる場面で適用できる7つのルールを提供します。 ２つのステップで書く: まずはアイディアにフォーカスし、その後レビューを行ってテキストの形を整えます。 読者のターゲットを明確にする: それを読むのはだれですか？ シンプルなスタイルを使用する: 分かり易くシンプルに保ちます。正しい文法
reStructuredText入門
警告 この記事は古い為 easy_install の使用等、現在では非推奨の説明があります。インストール周りについては Windowsへのインストールの手順を参照してください。 reStructuredTextはreSTとも呼ばれます。 (http://docutils.sourceforge.net/rst.html (英語) を参照してください。) reSTは、プレーンテキストを使ったマークアップ言語で、パッケージのドキュメントを作成する際に、Pythonのコミュニティ内で広く使用されています。reSTの優れている点は、ソースのテキストの状態でもそのまま読むことができるという点です。LaTeXのように、マークアップの文法のせいで読みにくくなるということはありません。 以下のテキストは、reST形式のドキュメントのサンプルです。 ======== タイトル ======== セクション
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
https://sphinx-users.jp/cookbook/hosting/
htmlを直接書きたい
https://sphinx-users.jp/articles/business-document-sample/
プロジェクトタイトル