|
Sphinx (ドキュメンテーションジェネレータ)
Sphinxは、Pythonで書かれているドキュメンテーションジェネレータである。 主にPythonコミュニティで利用されているが、その他の環境でも利用されている。 目的と機能SphinxはreStructuredTextをHTML (ウェブサイト) やPDF、EPUB、Texinfo及びmanページなどの他のフォーマットに変換する。 reStructuredTextには拡張性があり、Sphinxはソースコードからのドキュメントの自動生成、数式の表現、ソースコードのシンタックスハイライトなどにこれを利用している。 歴史と用例最初の公開リリースであるバージョン 0.1.61611は2008年3月21日に発表された[2]。 SphinxはPythonプロジェクトのドキュメントのために開発され、広く利用されている[3]。 Sphinxは2008年に公開されて以来、Bazaar、SQLAlchemy、MayaVi、SageMath、SciPy、Django、Pylonsなどの他の多くの重要なPythonプロジェクトで採用されている。 また、Blenderのユーザーマニュアル[4]やPythonのAPIドキュメント[5]にも採用されている。 2010年、Eric Holscherはソフトウェアドキュメントの保守を容易にするための取り組みの一環として、Read the Docsプロジェクトを発表した[6]。 Read the Docsは、各コミット時にSphinxドキュメントの生成とアップロードを自動的に行う。 LinuxカーネルLinuxカーネルのドキュメントサブシステムは2016年に変更された。 バージョン 4.7以降では、ドキュメントはSphinxを使用するように変更されている[7]。
脚注
外部リンク |
Index:
pl ar de en es fr it arz nl ja pt ceb sv uk vi war zh ru af ast az bg zh-min-nan bn be ca cs cy da et el eo eu fa gl ko hi hr id he ka la lv lt hu mk ms min no nn ce uz kk ro simple sk sl sr sh fi ta tt th tg azb tr ur zh-yue hy my ace als am an hyw ban bjn map-bms ba be-tarask bcl bpy bar bs br cv nv eml hif fo fy ga gd gu hak ha hsb io ig ilo ia ie os is jv kn ht ku ckb ky mrj lb lij li lmo mai mg ml zh-classical mr xmf mzn cdo mn nap new ne frr oc mhr or as pa pnb ps pms nds crh qu sa sah sco sq scn si sd szl su sw tl shn te bug vec vo wa wuu yi yo diq bat-smg zu lad kbd ang smn ab roa-rup frp arc gn av ay bh bi bo bxr cbk-zam co za dag ary se pdc dv dsb myv ext fur gv gag inh ki glk gan guw xal haw rw kbp pam csb kw km kv koi kg gom ks gcr lo lbe ltg lez nia ln jbo lg mt mi tw mwl mdf mnw nqo fj nah na nds-nl nrm nov om pi pag pap pfl pcd krc kaa ksh rm rue sm sat sc trv stq nso sn cu so srn kab roa-tara tet tpi to chr tum tk tyv udm ug vep fiu-vro vls wo xh zea ty ak bm ch ny ee ff got iu ik kl mad cr pih ami pwn pnt dz rmy rn sg st tn ss ti din chy ts kcg ve
