Sphinx is a documentation generator that can create HTML and other formats from reStructuredText markup and Python docstrings. It supports features like automatic cross-referencing, built-in search, and the ability to extend and customize the templates. Documentation built with Sphinx can be hosted on sites like ReadTheDocs for easy web hosting of project documentation.

1. X.
...Ruby 02
› ..@toRuby

3. Sphinx
• Wiki. . (reST). .. HTML
PDF. ...
• $. . ..
•
(Erlang .nginx. OK)
. ..
• HTML. .JS
http://sphinx.pocoo.org
http://sphinx.pocoo.org

4. ! ... ..

5. .
.
http://sphinx.shibu.jp
http://sphinx.shibu.jp

6. .
.
http://bitbucket.org/shibu/sphinx/
http://bitbucket.org/shibu/sphinx/

7. http://www.shibu.jp/sdeditext/
http://www.shibu.jp/sdeditext/

8. . ..

9. $

10. $ s

11. $ su

12. $ sud

13. $ sudo

14. $ sudo p

15. $ sudo po

16. $ sudo por

17. $ sudo port

18. $ sudo port i

19. $ sudo port in

20. $ sudo port ins

21. $ sudo port inst

22. $ sudo port insta

23. $ sudo port instal

24. $ sudo port install

25. $ sudo port install p

26. $ sudo port install py

27. $ sudo port install pyt

28. $ sudo port install pyth

29. $ sudo port install pytho

30. $ sudo port install python

31. ... . . ... .
Taken by noukorama under CC BY-NC-SA

32. .. .......

33. Sphinx 3...
APSW: http://apsw.googlecode.com/svn/publish/index.html Py on Windows: http://timgolden.me.uk/python-on-windows/
boostmpi: http://documen.tician.de/boostmpi/ PyCuda: http://documen.tician.de/pycuda/
Calibre: http://calibre.kovidgoyal.net/user_manual/ PyEphem: http://rhodesmill.org/pyephem/
Python
Chaco: http://code.enthought.com/projects/chaco/docs/html/ Pyevolve: http://pyevolve.sourceforge.net/
CodePy: http://documen.tician.de/codepy/ PyLit: http://pylit.berlios.de/
Cython: http://docs.cython.org/ Pylo: http://documen.tician.de/pylo/
C/C++ Python language binding project: http://language- Pylons: http://docs.pylonshq.com/
binding.net/index.html PyMOTW: http://www.doughellmann.com/PyMOTW/
Director: http://packages.python.org/director/ PyPubSub: http://pubsub.sourceforge.net/
Djagios: http://djagios.org/ pyrticle: http://documen.tician.de/pyrticle/
Django: http://docs.djangoproject.com/ Pysparse: http://pysparse.sourceforge.net/
F2py: http://www.f2py.org/html/ Python: http://docs.python.org/
Selenium
GeoDjango: http://geodjango.org/docs/ python-apt: http://people.debian.org/~jak/python-apt-doc/
GeoServer: http://docs.geoserver.org/ PyUblas: http://documen.tician.de/pyublas/
Django
Glashammer: http://glashammer.org/ Quex: http://quex.sourceforge.net/
Grok: http://grok.zope.org/doc/current/ Reteisi: http://docs.argolinux.org/reteisi/
Hedge: http://documen.tician.de/hedge/ Roundup: http://www.roundup-tracker.org/
IFM: http://fluffybunny.memebot.com/ifm-docs/index.html Sage: http://sagemath.org/doc/
Jinja: http://jinja.pocoo.org/2/documentation/ Satchmo: http://www.satchmoproject.com/docs/svn/
LEPL: http://www.acooke.org/lepl/ Scapy: http://www.secdev.org/projects/scapy/doc/
MapServer: http://mapserver.org/ Selenium: http://seleniumhq.org/docs/
Self
Matplotlib: http://matplotlib.sourceforge.net/ Self: http://selflanguage.org/
Mayavi: SimPy: http://simpy.sourceforge.net/
http://code.enthought.com/projects/mayavi/docs/development/html/mayavi Sphinx: http://sphinx.pocoo.org/
MeshPy: http://documen.tician.de/meshpy/ Sprox: http://sprox.org/
TurboGears
MirrorBrain: http://mirrorbrain.org/docs/ SQLAlchemy: http://www.sqlalchemy.org/docs/
Mixin.com: http://dev.mixin.com/ Sqlkit: http://sqlkit.argolinux.org/
Zope3
mpmath: http://mpmath.googlecode.com/svn/trunk/doc/build/index.html SymPy: http://docs.sympy.org/
MyHDL: http://www.myhdl.org/doc/0.6/ tinyTiM: http://tinytim.sourceforge.net/docs/2.0/
NetworkX: http://networkx.lanl.gov/ The Wine Cellar Book: http://www.thewinecellarbook.com/doc/en/
NumPy: http://docs.scipy.org/doc/numpy/reference/ TurboGears: http://turbogears.org/2.0/docs/
ObjectListView: http://objectlistview.sourceforge.net/python VOR: http://www.vor-cycling.be/
OpenEXR: http://excamera.com/articles/26/doc/index.html WebFaction: http://docs.webfaction.com/
OpenLayers: http://docs.openlayers.org/ WFront: http://discorporate.us/projects/WFront/
openWNS: http://docs.openwns.org/ WTForms: http://wtforms.simplecodes.com/docs/
Paste: http://pythonpaste.org/script/ Zope 3: e.g. http://docs.carduner.net/z3c-tutorial/
Paver: http://www.blueskyonmars.com/projects/paver/ zc.async: http://packages.python.org/zc.async/1.5.0/

34. .€

35. .€

36. .€

37. X.

38. ....5.

39. 55
55
Sphinx.
8
8
Wiki.. .

40. Sphinx.Wiki.
Sphinx Wiki
. .
HTML. HTML.
*%HTML *Web
. .
* è.. * è
. .. . ..

41. Sphinx.Wiki.
Sphinx Wiki
. .
HTML. HTML.
*%HTML *Web
. .
* è.. * è
. .. . ..

42. Sphinx.Wiki. . .
toRuby toRuby
Wiki
....Ruby
dRuby.
RWiki Ruby
def ¯
...Ruby
01 Hiki
02
C

43. X.

44. ..¯ .. .. . .

45. .X..Ë .
. .

46. .... .€
8. .... .

47. . e. e. .®..
. . ð .
.€ .

48. ... e.€ . .
..... ..
. .. . e.
€ .

49. € 8..
/
@ . ..5 u

50. € 8..
@ . ..5 u

52. IT¼ . ... .
..
......
......
..
..
.

53. .
.

54. . ...
...

55. .
...

56. . . . .. . ..
* . ....
* .. . ..

57. . . ....
.. ..
*xUnit..... .
http://www.hyuki.com/yukiwiki/wiki.cgi?JUnit.( ¢. ..

58. • . .....
– diff.L / . . è
– .... .
• $. .

59. . ...
• Sphinx.SUnit
– .
– . ”. .
•
–PySpec3.. .
Taken by ifranz under CC BY-NC

60. . Ruby.Sphinx /
• . . . !
–xUnit Wiki
• .e .Î
. . ../
• . ...

62. Python. ..º .. . ....
C . $ . . . . .. .º .. .
e .'... . ..
Wergzueg 0.2.... .. .. ...Docutils
......Georg Brandl...
. . . ! ..
. . . .
.... .Python 2.6, 3.0.
L . ..Sphinx
Python

63. .
... . 3. .
...
... . API 3.
. . .. '. .. .¢.
. . ..
Ruby RD/Rdtool
Ruby RD/Rdtool .
. .
. ..
..
Twitter. ý ¢. ..

64. . . Python. .
.. .
Taken by noukorama under CC BY-NC-SA

65. • . (setuptools. ..)
$ sudo easy_install sphinx
• . .
$ sphinx-quickstart
http://blog.shibu.jp/article/32044108.html
.....

66. ... ..
• $ . .. ...
• $ . .OK.
. ...
• .$. !. . .. ...
Sphinx. .
Sphinx. . . . /
. . /