Sphinx-quickstart
Upcoming SlideShare
Loading in...5
×
 

Sphinx-quickstart

on

  • 2,759 views

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

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

Statistics

Views

Total Views
2,759
Views on SlideShare
2,753
Embed Views
6

Actions

Likes
0
Downloads
10
Comments
0

2 Embeds 6

http://www.slideshare.net 5
http://webcache.googleusercontent.com 1

Accessibility

Categories

Upload Details

Uploaded via as Apple Keynote

Usage Rights

© All Rights Reserved

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Processing…
Post Comment
Edit your comment
  • &#x8A2D;&#x697D;&#x3067;&#x3059;&#x3001;&#x301C;&#x301C;&#x301C; <br /> &#x672C;&#x65E5;&#x306F;&#x3001;Sphinx&#x3068;&#x3044;&#x3046;&#x30C4;&#x30FC;&#x30EB;&#x306E;&#x7C21;&#x5358;&#x306A;&#x7D39;&#x4ECB;&#x3092;&#x3057;&#x305F;&#x3044;&#x3068;&#x601D;&#x3044;&#x307E;&#x3059;&#x3002; <br /> &#x3068;&#x3044;&#x3046;&#x306E;&#x306F;&#x3001;&#x81EA;&#x5206;&#x81EA;&#x8EAB;&#x3001;&#x30C9;&#x30AD;&#x30E5;&#x30E1;&#x30F3;&#x30C8;&#x3092;&#x66F8;&#x304F;&#x3053;&#x3068;&#x306F;&#x3042;&#x307E;&#x308A;&#x306A;&#x3044;&#x306E;&#x3067;&#x3059;&#x304C;&#x3001;&#x30C9;&#x30AD;&#x30E5;&#x30E1;&#x30F3;&#x30C8;&#x4EE5;&#x5916;&#x3067;&#x306E;&#x4F7F;&#x3044;&#x65B9;&#x3067;&#x4FBF;&#x5229;&#x3060;&#x3068;&#x611F;&#x3058;&#x3066;&#x3044;&#x308B;&#x3053;&#x3068;&#x3001;&#x8FD1;&#x65E5;&#x767A;&#x8DB3;&#x3059;&#x308B;Sphinx&#x65E5;&#x672C;&#x30E6;&#x30FC;&#x30B6;&#x4F1A;&#x306B;&#x53C2;&#x52A0;&#x3055;&#x305B;&#x3066;&#x3044;&#x305F;&#x3060;&#x3044;&#x3066;&#x3044;&#x308B;&#x305F;&#x3081;&#x3067;&#x3059;&#x3002; <br />
  • &#x4ECA;&#x65E5;&#x306F;&#x3001;Sphinx&#x3063;&#x3066;&#x4F55;&#x3088;&#xFF1F;&#x3068;&#x3001;Sphinx&#x3067;&#x4F55;&#x304C;&#x3067;&#x304D;&#x308B;&#xFF1F;&#x3068;&#x3044;&#x3046;&#x3053;&#x3068;&#x3067; <br /> &#x5B9F;&#x969B;&#x306B;&#x89E6;&#x308A;&#x306A;&#x304C;&#x3089;&#x7C21;&#x5358;&#x306A;&#x7D39;&#x4ECB;&#x3092;&#x3057;&#x305F;&#x3044;&#x3068;&#x601D;&#x3044;&#x307E;&#x3059;&#x3002; <br />
  • Sphinx&#x3063;&#x3066;&#x306A;&#x3093;&#x3067;&#x3057;&#x3087;&#x3046;&#x3002; <br /> &#x30C9;&#x30AD;&#x30E5;&#x30E1;&#x30F3;&#x30C8;&#x3092;&#x304B;&#x3063;&#x3053;&#x826F;&#x304F;&#x4ED5;&#x4E0A;&#x3052;&#x3066;&#x304F;&#x308C;&#x308B;&#x30C4;&#x30FC;&#x30EB;&#x3067;&#x3059;&#x3002; <br />
  • Sphinx&#x3063;&#x3066;&#x306A;&#x3093;&#x3067;&#x3057;&#x3087;&#x3046;&#x3002; <br /> &#x30C9;&#x30AD;&#x30E5;&#x30E1;&#x30F3;&#x30C8;&#x3092;&#x304B;&#x3063;&#x3053;&#x826F;&#x304F;&#x4ED5;&#x4E0A;&#x3052;&#x3066;&#x304F;&#x308C;&#x308B;&#x30C4;&#x30FC;&#x30EB;&#x3067;&#x3059;&#x3002; <br />
  • &#x3002;&#x3002; <br /> &#x4ECA;&#x65E5;&#x306F;&#x3001;&#x57FA;&#x672C;&#x7684;&#x306A;&#x4F7F;&#x3044;&#x65B9;&#x3068;&#x3001;&#x7C21;&#x5358;&#x306A;&#x30C9;&#x30AD;&#x30E5;&#x30E1;&#x30F3;&#x30C8;&#x3092;&#x4F5C;&#x3063;&#x3066;&#x307F;&#x305F;&#x3044;&#x3068;&#x601D;&#x3044;&#x307E;&#x3059;&#x3002; <br />
  • &#x5B9F;&#x969B;&#x306B;Sphinx&#x3067;&#x4F5C;&#x3089;&#x308C;&#x305F;Python&#x30C9;&#x30AD;&#x30E5;&#x30E1;&#x30F3;&#x30C8;&#x3092;&#x898B;&#x3066;&#x307F;&#x308B; <br />
  • Sphinx&#x306E;&#x30A4;&#x30F3;&#x30B9;&#x30C8;&#x30FC;&#x30EB;&#x306F;&#x3068;&#x3066;&#x3082;&#x7C21;&#x5358;&#x3067;&#x3059; <br /> Python&#x304C;&#x30A4;&#x30F3;&#x30B9;&#x30C8;&#x30FC;&#x30EB;&#x3055;&#x308C;&#x3066;&#x3044;&#x308B;&#x74B0;&#x5883;&#x3067;&#x3042;&#x308C;&#x3070;&#x3001;easy_install&#x3067;&#x4E00;&#x767A;&#x30A4;&#x30F3;&#x30B9;&#x30C8;&#x30FC;&#x30EB;&#x3067;&#x304D;&#x307E;&#x3059;&#x3002; <br />
  • mac&#x306E;&#x5834;&#x5408;&#x306B;&#x306F;&#x3001;Macports <br /> windows&#x306E;&#x5834;&#x5408;&#x306B;&#x306F;&#x3001;&#x30C7;&#x30D5;&#x30A9;&#x30EB;&#x30C8;&#x3067;&#x306F;Python&#x304C;&#x30A4;&#x30F3;&#x30B9;&#x30C8;&#x30FC;&#x30EB;&#x3055;&#x308C;&#x3066;&#x3044;&#x306A;&#x3044;&#x306E;&#x3067; <br /> Python&#x30A4;&#x30F3;&#x30B9;&#x30C8;&#x30FC;&#x30EB;>easy_install&#x30A4;&#x30F3;&#x30B9;&#x30C8;&#x30FC;&#x30EB;>sphinx&#x30A4;&#x30F3;&#x30B9;&#x30C8;&#x30FC;&#x30EB;&#x306E;&#x6D41;&#x308C;&#x306B;&#x306A;&#x308A;&#x307E;&#x3059;&#x3002; <br />
  • Sphinx&#x3067;&#x30C9;&#x30AD;&#x30E5;&#x30E1;&#x30F3;&#x30C8;&#x3092;&#x751F;&#x6210;&#x3059;&#x308B;&#x6D41;&#x308C;&#x306F; <br /> reStructuredText&#x3067;&#x30BD;&#x30FC;&#x30B9;&#x3092;&#x8A18;&#x8FF0;&#x3057;&#x3066; >> <br />
  • &#x30BD;&#x30FC;&#x30B9;(reST)&#x3092;&#x30D3;&#x30EB;&#x30C9;&#x3059;&#x308B;&#x3053;&#x3068;&#x3067;&#x3001;HTML&#x3001;PDF(rst2pdf)&#x306A;&#x3069;&#x306E;&#x5F62;&#x5F0F;&#x3067;&#x51FA;&#x529B;&#x3059;&#x308B;&#x3053;&#x3068;&#x304C;&#x51FA;&#x6765;&#x307E;&#x3059;&#x3002; <br /> &#xFF1E;&#xFF1E;&#x30C7;&#x30E2; <br />
  • &#x3082;&#x3063;&#x3068;&#x3001;&#x826F;&#x3044;&#x30C9;&#x30AD;&#x30E5;&#x30E1;&#x30F3;&#x30C8;&#x3092;&#x4ED5;&#x4E0A;&#x3052;&#x308B;&#x306B;&#x306F;&#x3001;&#x516C;&#x5F0F;&#x30B5;&#x30A4;&#x30C8;&#x304A;&#x3088;&#x3073;&#x65E5;&#x672C;&#x8A9E;&#x8A33;&#x306E;&#x30EA;&#x30D5;&#x30A1;&#x30EC;&#x30F3;&#x30B9;&#x3092;&#x53C2;&#x7167;&#x3057;&#x3066;&#x304F;&#x3060;&#x3055;&#x3044;&#x3002; <br />
  • &#x3068;&#x3001;&#x3053;&#x3053;&#x307E;&#x3067;&#x3001;&#x57FA;&#x672C;&#x7684;&#x306A;&#x30C9;&#x30AD;&#x30E5;&#x30E1;&#x30F3;&#x30C8;&#x3092;&#x4F5C;&#x6210;&#x3057;&#x307E;&#x3057;&#x305F;&#x304C; <br /> &#x30C9;&#x30AD;&#x30E5;&#x30E1;&#x30F3;&#x30C8;&#x4EE5;&#x5916;&#x306B;&#x3082;&#x3044;&#x308D;&#x3044;&#x308D;&#x4F7F;&#x3044;&#x9053;&#x3058;&#x3083;&#x306A;&#x3044;&#x304B;&#x306A; <br />

Sphinx-quickstart Sphinx-quickstart Presentation Transcript

  • $ sphinx-quickstart
  • agenda
  • Sphinx
  • http://docs.python.org/
  • easy_install sphinx
  • x/M ac Linu # easy_install sphinx or # port install py26-sphinx dows 1.Python Win 2.easy_install 3.easy_install sphinx
  • 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.
  • http://sphinx.pocoo.org/