Unverified details These details have not been verified by PyPI Project links Homepage Download Meta License: BSD License (BSD) Author: Yuya Nishihara Classifiers Development Status 4 - Beta Environment Console Web Environment Framework Sphinx :: Extension Intended Audience Developers License OSI Approved :: BSD License Operating System OS Independent Programming Language Python Topic Documentatio
Sphinx ã«ã¯ Sphinx æ¡å¼µ(Sphinx extension)ã¨å¼ã°ãããã©ã°ã¤ã³æ©è½ãããã¾ãã Sphinx æ¡å¼µã使ãã¨ããã¥ã¡ã³ããæ¸ãã®ããã便å©ã«ãªã£ããã ããã¥ã¡ã³ãã®è¡¨ç¾ãããè±å¯ã«ãªã£ãããã¾ãã ä»æ¥ã¯ãã® Sphinx æ¡å¼µã®ä¸ããåããã使ããã®ã便å©ããã§ä½¿ã£ã¦ã¿ãããã®ã ããããããã¤ãããã¯ã¢ãããã¦ãç´¹ä»ãã¾ãã sphinx.ext.todo Sphinx ã«å梱ããã¦ããæ¡å¼µã¢ã¸ã¥ã¼ã«ã§ãããã¥ã¡ã³ãã« ToDo ãæ¸ãæ®ããã¨ãã§ãã¾ãã æå¹ã«ããã«ã¯ conf.py ã«ä»¥ä¸ã®è¨è¿°ã追å ãã¾ãã # sphinx.ext.todo ã¢ã¸ã¥ã¼ã«ãèªã¿è¾¼ã extensions += ['sphinx.ext.todo'] # ToDo é ç®ã表示ãã (ããã©ã«ãã¯è¡¨ç¤ºããªã; False) todo_include_todos = T
sphinx theme for dotted style documentation Dotted style theme sample for Sphinx Contents :: Readme  » Readme conf.py sample Sample Document History and Authors Dotted style theme sample for Sphinx¶ Quick start¶ install: $ pip sphinxjp.themes.dotted setup your conf.py with: html_theme = 'dotted' and run: $ make html then your will get this pageâs style HTML output. Links¶ download:https://github.c
大ååã«ãããªæãã®äºãããã®ã§ããã®æã®è¦ãæ¸ããgithubã§ç®¡çããã¦ããOSSãªããã§ã¯è¯ããä¸è¨ã®ãããªURLã§ããã¥ã¡ã³ããå ¬éãã¦ããããã¸ã§ã¯ããããã¾ãããã http://[account_name].github.com/[repository_name]/ account_name(ã¢ã«ã¦ã³ãå)ããµããã¡ã¤ã³ repository_nameã対象ã®ãªãã¸ããªå ããã©ããã£ã¦ãã ããï¼ã¨æã£ã¦ãã®ããã£ããã§ãã以ä¸æé ãè¦ã¦ã¿ã¾ããããåæã¨ãã¦æ¢ã«githubä¸ã«ãªãã¸ããªãæã£ã¦ãããã¨ã¨ãã¾ãã GitHub Pagesãç¨æãã ãããããä¸ã®URLä½ç³»ã§ãã¼ã¸ãåç §ã§ããã®ã¯ãGithub Pagesã®ãããã®ãããªã®ã§ãã¾ãã¯ãããç¨æãã¾ããGithub Pagesãå©ç¨ãã¦ããªããªãã¸ããªã§ä¸ã®ãããªURLã«ã¢ã¯ã»ã¹ããã¨ããä¸å¯§ã«ãã¼ã¸ã®ä½ãæ¹
I wrote this post in 2012, more than 12 years ago. It may be very out of date, partially or totally incorrect. I may even no longer agree with this, or might approach things differently if I wrote this post today. I rarely edit posts after writing them, but if I have there'll be a note at the bottom about what I changed and why. If something in this post is actively harmful or dangerous please get
ããã¥ã¡ã³ãã¨ãããããå¤æ´å±¥æ´ãæ¸ãã®ãç¡æ§ã«é¢åãããããããããããå¤æ´å±¥æ´ãè¦ãã ããããä½ãå¤ãããå¾ããåãããªãã§ããã ãã£ã¡ãã£ããããã£ã¡ãã£ããããã®ã¯é¢åãªã®ã§ã¾ã¨ãã¦ããã å ¨é¨å ¥ãã¦ãOKãã©ããã¯è©¦ãã¦ããªãã®ã§ãããã¯èªå·±è²¬ä»»ã§ãé¡ããã¾ãã 1.ã¤ã³ã¹ãã¼ã« ã¤ã³ã¹ãã¼ã«ã¯ããã¥ã¢ã«ã©ããã«ã Windowsã¸ã®ã¤ã³ã¹ãã¼ã« :: ããã¥ã¡ã³ãã¼ã·ã§ã³ãã¼ã« ã¹ãã£ã³ã¯ã¹ Sphinx-users.jp ãªã¼ã«ã¤ã³ã¯ã³ã使ããªãã®ã¯ãSphinxã®ãã¼ã¸ã§ã³ãå¤ãããã 2.æ¥æ¬èªç°å¢è¨å® æ¥æ¬èªã®ãã¡ã¤ã«åãæç« ã«ããã¨ãã¯ä»¥ä¸ã®ãã¨ãããã 1)æ¥æ¬èªãã©ã«ã/ãã¡ã¤ã«åãæ±ããããã«ãããããã®é©ç¨ [Sphinx][Cygwin] æ¥æ¬èªãã©ã«ã/ãã¡ã¤ã«åãæ±ããããã«ããããããä½ã£ã #sphinxjp | åè¢éé blog.hansod
http://pages.github.com/ GitHub Pages ã¨ãããã®ããããç°¡åãªè¦åã«æ²¿ã£ã¦ãã¼ã¸ãä½ãã°ãµããã¡ã¤ã³ã§ã®ãã¼ã¸ãä½ããæãã®ãµã¼ãã¹ã¨èªèãããè¦åã¯ç°¡åã irof.github.com ã¨ãããªãã¸ããªãä½ã ããã« index.html ãç½®ã ããããå¾ã¯GitHubãåæã«è¯ãããã«ãã¦ããã¦ãhttp://irof.github.com/ ã§ã¢ã¯ã»ã¹ã§ããããã«ãªããç´ æ´ããããï¼ãã®æç¹ã§ã¯ãhello, worldãã¨ã ãæ¸ãã¦ãï¼ ã§ãHTMLãªãã¦ãã¡ãã¡æ¸ãã¦ãããªãããGitHub Pagesã§ç´¹ä»ããã¦ãããããªJekyllãªãã¦ã®ã¯ç¥ããªãâ¦ã¨è¨ããHTMLã¯Sphinxã§åºãããã ãããç´ ç´ã« sphinx-quickstart ã§åºåããHTMLãpushããã¨ããã§ãGitHub Pages㯠_ ã§å§ã¾ãã®ã対象ã¨
ã¿ã¤ãã«éãã®ãã¨ãããã ã¢ã«ã¦ã³ãå.github.com ã¨ããååã®ãªãã¸ããªãä½ã ããcloneãã cd ã¢ã«ã¦ã³ãå.github.com git submodule add git://github.com/michaeljones/sphinx-to-github ãã£ãºãã¨ãããã git commit -m "added sphinx-to-github as submodule" && git push ãã sphinx-quickstart (å ¨é¨é©å½ã«enterããªãããããªãããªããªãã®ã¯é©å½ã«æ¸ãã¦enter) rm -rf _* conf.py ã®ä¸ã html_static_path = ['static'] ã¨å¤æ´ ã¢ã³ã extensions = [ "sphinxtogithub" ] ã¨å¤æ´ ã¢ã³ã æ«å°¾ã«ã§ã sphinx_to_githu
Sphinx ã§ä¼ç¤¾ã®è£½åãµã¤ããä½ã£ã¦ 4 ã¶æ以ä¸éãã¾ãããå®éã«éç¨ãã¦ã¿ãææ³ãªã©ãã åæ ãã¶ã¤ãã¼ @kinofumi ã«ä¾é ¼ãã¦ãSphinx ã®å°ç¨ãã¼ããä½ã£ã¦è²°ãã¾ããã@kinofumi 㯠Jinja2 ã使ãããªãã¦ãã¾ã£ããã¨ãã¶ã¤ãã¼ï¼ãªã®ãæªããã§ãããã¨ã¦ãã¹ãããªãµã¤ããåºæ¥ã¾ããã åç¨è£½åãµã¤ããªã®ã§ãã¨ã«ããè¦ããããã¨ãç¥ãããæ å ±ãè¦ã¤ãããã¨ã第ä¸ã«ä½ã£ã¦è²°ãã¾ããã ãªãªã¼ã¹ç°å¢ S3 ã«ãããã¤ãã¦ãã¼ããã·ã§ã³ã Public ã«ãã¦ãã¾ããURL 㯠DNS æå®ãã¦ããã ãã§ãã ãã以ä¸ã¯ç¹ã«ãã£ã¦ãã¾ããã è²»ç¨ ã¢ã¯ã»ã¹ã 1 æ¥ 100 人æªæºã§ãããããã 1000 人ãè¦ã«æ¥ãããã«ãªã£ããåé¡ã§ãã ã§ãå®éãããããã£ãã®ããã¨ãã話ãã§ãã ä»ã®ã¨ããä¸ã¶æé£ç¶ã§ $ 0.03 ã§ãä»æãä»ã®ã¨ãã $ 0.0
ä»å¾ãããã¥ã¢ã«ãæ¸ãã¦ã¡ã³ããã³ã¹ãç¶ç¶çã«ãã¦ããæ©ä¼ãä¸åº¦ãããããªã®ã§ãç¾æç¹(2012/05/02)ã§ã©ã®ãã¼ã«ãèªåãã¡ã«ãã£ãããããæ¤è¨ãã¦ã¿ãããã¼ã«ã®åè£ã¯ä»¥ä¸ããªããéå»ã®ä»äºã§ã¯Wordã¨DocBookã¯çµé¨ããã Word DocBook Sphinx ReVIEW åæ ä»åã®ããã¥ã¢ã«ä½æã®åæã¯ä»¥ä¸ã®éãã è¤æ°äººã§ä½æ¥ãã1ã¤ã®ããã¥ã¡ã³ããä½æãã(主ã«ç« åä½ã§ã¢ãµã¤ã³)ã ç¹å®é¡§å®¢åãã«é¨åçã«ã«ã¹ã¿ãã¤ãºãã¦æä¾ãããã¨ãããã å¤é¨åãã®ããã¥ã¡ã³ããªã®ã§ãä½è£ã¯ãããªãã«æ´ã£ã¦ããå¿ è¦ãããã 製åã®ã¨ãã£ã·ã§ã³ã«ãã£ã¦ããã¥ã¢ã«æ§æãå¤ãã(ä¸ä½ã®ã¨ãã£ã·ã§ã³ã ã¨æ©è½ãå¢ããã®ã§ç« ãç¯ã説æãå¢ãããªã©)ã åºåãã©ã¼ãããã¯Wordã¾ãã¯HTMLãªãOKãPDFã¯å¿ é ã§ã¯ãªãã ããã¥ã¡ã³ãä¸ã«ç»åã¯ãããªãã«ãããã¹ã¯ãªã¼ã³ãã£ããã£ãæ§æ
ãã¡ãã¡ããæ¹ã調ã¹ãã®ãããã©ããªã®ã§ãèªåã¡ã¢ãcommit pushãå¿ è¦ã§ãããèªåwikiç«ã¦ãã®ãããã©ããªããããããã§å åããªã¨ã ${USER_NAME}ã¨${REPOSITORY_NAME}ã¯é©å®èªåã®ç°å¢ã«ç½®ãæãã¦ãã ããã æºå ããããããgithubã«ã¬ãã¸ããªãä½ã£ã¦ããã¾ãã sphinxã¨sphinx-to-githubãã¤ã³ã¹ãã¼ã«ãã¦ããã¾ããpythonã¯pythonbrewãªãã·ã¹ãã ã®ãªããã©ã£ãããé©å½ã«ã¤ã³ã¹ãã¼ã«ãã¦ãã ããã pip install sphinx pip install -e "git+git://github.com/michaeljones/sphinx-to-github.git#egg=sphinx-to-github" ããã¸ã§ã¯ãã®ä½æ ãã¤ãã®ããã«gitã®ãã¼ã«ã«ã¬ãã¸ããªãä½æããsphinxã®éå½¢ãä½
GitHub Pagesã使ã£ã¦ææ¸ã管çãããå¿«é©ããã ã£ãã®ã§è©¦ãã¦ã¿ãã ãããµãHaskellã¨ãããã®ãæ¸ãã¦ã¾ãã Haskellã§äººå·¥ç¡è³ãã¤ãã£ã¦ã¿ããã¨ããPLEACåãããã¨ããInvent with Pythonãæ¸ããªããã¦ã¿ããã¨ãè²ã ãã£ãã®ã§GitHub+Sphinxã§ãããããªã£ãã¨ããã®ãã¢ããã¼ã·ã§ã³ã åºæ¬çãªæµãã¨ãã¦ã¯ gh-pagesã¨ãããã©ã³ããä½ã sphinxtogithubã¨ããã¨ã¯ã¹ãã³ã·ã§ã³ãå ¥ãã Sphinxã§æç« ãæ¸ã make htmlãã cp -pr _build/html/* ./ã§ãã«ããããhtmlãã«ã¬ã³ããã£ã¬ã¯ããªã«ç§»åãã commitãã¦pushããã¨å ¬éã§ããããã«ãªã ã¨ãªããã4-5ã®ã¹ãããã¯ããã¡ãã£ã¨ã¹ãã¼ãã«ã§ããã¨æããã¡ãªã¿ã«åèã«ããã®ã以ä¸ã®ãµã¤ãã ãã©ããªãã£ã·ã£ã«ã®ãã«ãã«ã¯ä¸é
ãã®è¨äºã¯ Sphinx ã¢ããã³ãã«ã¬ã³ãã¼ã® 19æ¥ç®ã§ãã markdown 㨠Sphinx (reST) Sphinx ã§ã¯ææ¸ãæ¸ãéã®è¨è¿°ãã©ã¼ãããã« reStructured Text ãå©ç¨ãã¦ãã¾ããã ä¸ãåºãè¦åãã¨ãgithub ç¶ããbitbucket ç¶ããæ§ã ãªå ´æ㧠markdown ãã©ã¼ããããå©ç¨ããã¦ãã¾ãã markdown ãã©ã¼ããã㯠reST ã¨æ¯ã¹ãã¨è¡¨ç¾åãä½ãä¸ã表ç¾ãæ¡å¼µãããã¨ãã§ããªãã¨ããç¹ãææããã¦ãã¾ãã 表ç¾ãæ¡å¼µãããã¨ãã§ããªããããããã¤ãã®æ¹è¨ãåå¨ããã¨ããåé¡ãããã¾ãã ã§ãããreST ã¨æ¯ã¹ã¦ã·ã³ãã«ã§ããªããã¤ããã¥ã©ã¼ã«å©ç¨ããã¦ãããã©ã¼ãããã§ããããã æ°ãã Sphinx ã«è§¦ãå§ãã人ã®åã£æããã¨ãã¦ã¯ãmarkdown ã¯ãã£ã¦ã¤ãã®ãã©ã¼ãããã¨è¨ãã¾ãã sphinxcont
Sphinx Advent Calendar 2012 - connpass ã®23 æ¥ç®ã§ãã æ¨æ¥ã¯ Harrison ããã® Sphinx ã¢ããã³ãã«ã¬ã³ãã¼22æ¥ç® ã§ãããå£ãã³ã£ã¦éããã¨ãã®ããã§ããããå£å£ãã³ãã³*1ãé¢ä¿ãåã«é²ã¿ãããªæãã§ãã*2ãã¨ãããã¨ã§Advent Calenderååå ã§ãããã¾ã*3*4ã ã¯ããã« Sphinxçéã®çæ§ãã¯ããã¾ãã¦ãæ±èã®å¤ãã§å®è©ã®ãã @tboffice ã¨ç³ãã¾ãããããããé¡ããã¾ã*5ã Sphinxã§èãæ¬ãä½ã£ã話ããã¾ããèãæ¬ã«ã¤ãã¦ã¯æå¾ã®æ¹ã§è§¦ãã¾ãã ãããã å®ã¯ããã®ã¨ã³ããªã®ã¿ã¤ãã«ã«ããªã£ã¦ãããèãæ¬ãã¯ãä»å¹´ã®å¤é ã«ãä½ãã¾ããããã®ã¨ãã¯è¤æ°äººã§ç´ ã®texå稿ãæ¸ãã¦æã¡å¯ã£ã¦ãdvipdfmxã³ãã³ãããããã¦ãã«ããã¦ãã¾ããã ãã®ã¨ãä¸ç·ã«å·çãã¦ããid:j5ik2o
ã§ä½¿ããããã«ãªãã ãã¾ãCSSããããæ°ããªããã°ããã§ããããªã¨æãããå¼ãããå ´åã«ã¯ãã£ã¡ã®ããæ¹ã®ã»ããããããªã ãã¨ã§ä½ãã§ä½¿ã£ã¦ã¿ããã£ã¨ã
shomah4a.net 2021 èä½æ¨©. ä¸è¨±è¤è£½ ãã©ã¤ãã·ã¼ããªã·ã¼
A project Download ç¾å¨ã®ãã¼ã¸ã§ã³: 1.4.4 Python Package Indexããã½ã¼ã¹ã³ã¼ãããã¦ãã¼ããããã以ä¸ã®ã³ãã³ãã§ã¤ã³ã¹ãã¼ã«ãã¦ãã ãã: pip install -U Sphinx çå? æè¦? Googleã°ã«ã¼ãã®sphinx-users ã°ã«ã¼ãã¸ã®åå ãããã¯ãFreeNodeã®#sphinx-docãã£ã³ãã«ã¸ã©ããã ä½ãæ°ã¥ãããã¨ãããã°ãissue trackerã使ç¨ãã¦å ±åãããã¨ãã§ãã¾ãã Sphinxã¯ç¥çã§ç¾ããããã¥ã¡ã³ããç°¡åã«ä½ããããã«ãããã¼ã«ã§ããGeorg Brandlã«ãã£ã¦éçºãããBSDã©ã¤ã»ã³ã¹ã®ãã¨ã§å ¬éããã¦ãã¾ãã ãã®ãã¼ã«ã¯ãã¨ãã¨ãæ°ããPythonã®ããã¥ã¡ã³ãã®å¤æã®ããã«ä½ããã¾ãããPythonã®ããã¸ã§ã¯ãã®ããã®ãã°ãããæ©è½ãæä¾ãã¦ãã¾ããããç¾å¨ã§ã¯C/
Sphinx makes it easy to create intelligent and beautiful documentation. Here are some of Sphinxâs major features: Output formats: HTML (including Windows HTML Help), LaTeX (for printable PDF versions), ePub, Texinfo, manual pages, plain text Extensive cross-references: semantic markup and automatic links for functions, classes, citations, glossary terms and similar pieces of information Hierarchic
ã©ã³ãã³ã°
ã©ã³ãã³ã°
ã©ã³ãã³ã°
ãªãªã¼ã¹ãé害æ å ±ãªã©ã®ãµã¼ãã¹ã®ãç¥ãã
ææ°ã®äººæ°ã¨ã³ããªã¼ã®é ä¿¡
å¦çãå®è¡ä¸ã§ã
j次ã®ããã¯ãã¼ã¯
kåã®ããã¯ãã¼ã¯
lãã¨ã§èªã
eã³ã¡ã³ãä¸è¦§ãéã
oãã¼ã¸ãéã
{{#tags}}- {{label}}
{{/tags}}