Sphinxで作ったドキュメントのホスティング
Sphinxで作ったドキュメントのホスティング¶ 日時: 2010/09/05 更新日: 2021/04/04 作者: 渋川よしき、山口能迪、清水川貴之、うさたーん Sphinxでドキュメントを作ったら公開したいですよね？自分のホームページ作成のように、FTPを使って、プロバイダーなどで提供されている所に置くというのも当然できますが、ここではいくつか別の方法を紹介します。 Github Pagesを使ってドキュメントを公開¶ Github Pagesを使えば、個人や組織のウェブサイト、リポジトリのウェブサイトを作ることができます。 必要なもの¶ Githubのアカウント git ケース1: 個人や組織のウェブサイトの公開手順¶ ユーザ名.github.io という名前のリポジトリを作成します(ここのユーザ名は個人のアカウント名、もしくは組織名です)。 SphinxでビルドしたHTML群を登
技術文書を書くための７つのルール
技術文書を書くための７つのルール¶ さまざまな面から見て、良いドキュメントを書くことは、良いコードを書くよりも簡単です。多くの開発者はドキュメントを書くのはとても難しいことであると考えていますが、いくつかのシンプルなルールに従うだけで、本当に簡単になります。 ここでお話しするのは、ポエムの本を書くための方法ではなく、プログラムの設計やAPI、コードベースを作り上げる上で、必要となるものを理解するための包括的なテキストを書くための方法になります。 全ての開発者はそのようなテキストを書くことができます。本節ではあらゆる場面で適用できる7つのルールを提供します。 ２つのステップで書く: まずはアイディアにフォーカスし、その後レビューを行ってテキストの形を整えます。 読者のターゲットを明確にする: それを読むのはだれですか？ シンプルなスタイルを使用する: 分かり易くシンプルに保ちます。正しい文法
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
