Your SlideShare is downloading. ×
Sphinx-quickstart
Upcoming SlideShare
Loading in...5
×

Thanks for flagging this SlideShare!

Oops! An error has occurred.

×
Saving this for later? Get the SlideShare app to save on your phone or tablet. Read anywhere, anytime – even offline.
Text the download link to your phone
Standard text messaging rates apply

Sphinx-quickstart

2,206
views

Published on

電設部IT勉強会#3の発表資料です。

電設部IT勉強会#3の発表資料です。

Published in: Technology

0 Comments
0 Likes
Statistics
Notes
  • Be the first to comment

  • Be the first to like this

No Downloads
Views
Total Views
2,206
On Slideshare
0
From Embeds
0
Number of Embeds
0
Actions
Shares
0
Downloads
11
Comments
0
Likes
0
Embeds 0
No embeds

Report content
Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
No notes for slide
  • 設楽です、〜〜〜
    本日は、Sphinxというツールの簡単な紹介をしたいと思います。
    というのは、自分自身、ドキュメントを書くことはあまりないのですが、ドキュメント以外での使い方で便利だと感じていること、近日発足するSphinx日本ユーザ会に参加させていただいているためです。
  • 今日は、Sphinxって何よ?と、Sphinxで何ができる?ということで
    実際に触りながら簡単な紹介をしたいと思います。
  • Sphinxってなんでしょう。
    ドキュメントをかっこ良く仕上げてくれるツールです。
  • Sphinxってなんでしょう。
    ドキュメントをかっこ良く仕上げてくれるツールです。
  • 。。
    今日は、基本的な使い方と、簡単なドキュメントを作ってみたいと思います。
  • 実際にSphinxで作られたPythonドキュメントを見てみる
  • Sphinxのインストールはとても簡単です
    Pythonがインストールされている環境であれば、easy_installで一発インストールできます。
  • macの場合には、Macports
    windowsの場合には、デフォルトではPythonがインストールされていないので
    Pythonインストール>easy_installインストール>sphinxインストールの流れになります。
  • Sphinxでドキュメントを生成する流れは
    reStructuredTextでソースを記述して >>
  • ソース(reST)をビルドすることで、HTML、PDF(rst2pdf)などの形式で出力することが出来ます。
    >>デモ
  • もっと、良いドキュメントを仕上げるには、公式サイトおよび日本語訳のリファレンスを参照してください。
  • と、ここまで、基本的なドキュメントを作成しましたが
    ドキュメント以外にもいろいろ使い道じゃないかな
  • Transcript

    • 1. $ sphinx-quickstart
    • 2. agenda
    • 3. Sphinx
    • 4. http://docs.python.org/
    • 5. easy_install sphinx
    • 6. x/M ac Linu # easy_install sphinx or # port install py26-sphinx dows 1.Python Win 2.easy_install 3.easy_install sphinx
    • 7. Introduction ============ This is the documentation for the Sphinx documentation builder. Sphinx is a tool that translates a set of reStructuredText_ source files into various output formats, automatically producing cross-references, indices etc. That is, if you have a directory containing a bunch of reST-formatted documents (and possibly subdirectories of docs in there as well), Sphinx can generate a nicely-organized arrangement of HTML files (in some other directory) for easy browsing and navigation. But from the same source, it can also generate a LaTeX file that you can compile into a PDF version of the documents. The focus is on hand-written documentation, rather than auto-generated API docs. Though there is limited support for that kind of docs as well (which is intended to be freely mixed with hand-written content), if you need pure API docs have a look at `Epydoc <http://epydoc.sf.net/>`_, which also understands reST. Conversion from other systems ----------------------------- This section is intended to collect helpful hints for those wanting to migrate to reStructuredText/Sphinx from other documentation systems. * Gerard Flanagan has written a script to convert pure HTML to reST; it can be found at `BitBucket <http://bitbucket.org/djerdo/musette/src/tip/musette/html/html2rest.py>`_. * For converting the old Python docs to Sphinx, a converter was written which can be found at `the Python SVN repository <http://svn.python.org/projects/doctools/converter>`_. It contains generic code to convert Python-doc-style LaTeX markup to Sphinx reST. * Marcin Wojdyr has written a script to convert Docbook to reST with Sphinx markup; it is at `Google Code <http://code.google.com/p/db2rst/>`_. Prerequisites ------------- Sphinx needs at least **Python 2.4** to run. If you like to have source code highlighting support, you must also install the Pygments_ library, which you can do via setuptools' easy_install. Sphinx should work with docutils version 0.4 or some (not broken) SVN trunk snapshot.
    • 8. http://sphinx.pocoo.org/

    ×