Sphinx (documentation generator)

Not to be confused with CMU Sphinx or Sphinx (search engine).
Sphinx
Developer(s)Georg Brandl
Initial releaseMarch 21, 2008 (2008-03-21)
Stable release
8.1.3[1] / October 13, 2024; 2 months ago (2024-10-13)
Repository
Written inPython
Operating systemCross-platform
TypeDocumentation generator
LicenseBSD
Websitewww.sphinx-doc.org

Sphinx is a documentation generator written and used by the Python community. It is written in Python, and also used in other environments.

Purpose and function

Sphinx converts reStructuredText files into HTML websites and other formats including PDF, EPub, Texinfo and man.

reStructuredText is extensible, and Sphinx exploits its extensible nature through a number of extensions – for autogenerating documentation from source code, writing mathematical notation or highlighting source code, etc.

HTML themes

Sphinx provides the ability to apply themes to HTML and HTML-based formats. Sphinx has several built-in themes, including alabaster, classic, sphinxdoc, and scrolls.[2] Popular themes that can be installed as Python modules include:[3]

History and use

The first public release, version 0.1.61611, was announced on March 21, 2008.[8] It was developed for, and is used extensively by, the Python project for documentation.[9]

Since its introduction in 2008, Sphinx has been adopted by many other important Python projects, including Bazaar, SQLAlchemy, MayaVi, SageMath, SciPy, Django and Pylons. It is also used for the Blender user manual[10] and Python API documentation.[11]

In 2010, Eric Holscher announced[12] the creation of the Read the Docs project as part of an effort to make maintenance of software documentation easier. Read the Docs automates the process of building and uploading Sphinx documentation after every commit.

Linux kernel

The Linux kernel's documentation subsystem underwent changes in 2016. Starting in the 4.7 cycle, the documentation started switching over to use Sphinx.[13]

See also

References

  1. ^ "Changes in Sphinx". Sphinx.
  2. ^ "HTML Theming". Sphinx documentation. Georg Brandl and the Sphinx team. Retrieved 2022-06-25.
  3. ^ "Sphinx Themes". Write the Docs. Retrieved 2022-06-25.
  4. ^ "Read the Docs Sphinx Theme". sphinx-rtd-theme code repository. GitHub. Retrieved 2022-06-25.
  5. ^ "Sphinx Bootstrap Theme". sphinx_bootstrap_theme code repository. GitHub. Retrieved 2022-06-25.
  6. ^ "Guzzle Sphinx Theme". guzzle_sphinx_theme code repository. GitHub. Retrieved 2022-06-25.
  7. ^ "Documatt Sphinx Themes Collection". Documatt.com. Retrieved 2022-06-25.
  8. ^ "Sphinx is released! » And now for something completely Pythonic..." And now for something completely Pythonic... Georg Brandl. Archived from the original on 2012-03-22. Retrieved 2011-04-03.
  9. ^ "About these documents — Python v2.7.1 documentation". Python documentation. Python Software Foundation. Retrieved 2011-04-03.
  10. ^ "Blender User Manual". Blender Wiki. Blender Foundation.
  11. ^ "Dev:2.5/Py/API/Generating API Reference - BlenderWiki!". Blender Foundation.
  12. ^ "Announcing Read The Docs". Python Software Foundation News. Eric Holscher. Retrieved 2015-02-15.
  13. ^ "Kernel documentation update". LWN.net. 2016-11-02.

Read other articles:

Lastri Berry Wijaya

Artikel ini sebatang kara, artinya tidak ada artikel lain yang memiliki pranala balik ke halaman ini.Bantulah menambah pranala ke artikel ini dari artikel yang berhubungan atau coba peralatan pencari pranala.Tag ini diberikan pada Desember 2022. Lastri Berry WijayaLahir14 September 1971 (umur 52)Curup, Rejang Lebong, Kabupaten Rejang Lebong, BengkuluKebangsaan IndonesiaPekerjaanPewarta foto dan penulisDikenal ataspewarta foto yang memperolah penghargaan dari National Press Photographers ...

 

Awan Morning Glory

Artikel ini sebatang kara, artinya tidak ada artikel lain yang memiliki pranala balik ke halaman ini.Bantulah menambah pranala ke artikel ini dari artikel yang berhubungan atau coba peralatan pencari pranala.Tag ini diberikan pada Februari 2023. Sebuah formasi awan Morning Glory pada wilayah perbatasan antara Burketown dan Normanton, Australia. Awan Morning Glory merupakan salah satu fenomena alam yang sangat langka. Peristiwa ini pernah terlihat di banyak lokasi berbeda di seluruh dunia, nam...

 

Kepada Apakah

Artikel ini sebatang kara, artinya tidak ada artikel lain yang memiliki pranala balik ke halaman ini.Bantulah menambah pranala ke artikel ini dari artikel yang berhubungan atau coba peralatan pencari pranala.Tag ini diberikan pada Januari 2023. Kepada Apakah PenyuntingAfrizal MalnaBahasa IndonesiaGenreNovelPenerbitMotion PublishingTanggal terbit14 Februari 2014Halaman302 halamanISBNISBN 978-602-70054-0-2 Kepada Apakah adalah judul novel karya Afrizal Malna yang diterbitkan oleh Motion Pu...

منتخب الصين لكرة القدم الشاطئية

يفتقر محتوى هذه المقالة إلى الاستشهاد بمصادر. فضلاً، ساهم في تطوير هذه المقالة من خلال إضافة مصادر موثوق بها. أي معلومات غير موثقة يمكن التشكيك بها وإزالتها. (مارس 2016) منتخب الصين لكرة القدم الشاطئية معلومات عامة بلد الرياضة  الصين رمز الفيفا CHN  الاتحاد اتحاد الصين لكر...

 

Tonghae Satellite Launching Ground

Artikel ini perlu diwikifikasi agar memenuhi standar kualitas Wikipedia. Anda dapat memberikan bantuan berupa penambahan pranala dalam, atau dengan merapikan tata letak dari artikel ini. Untuk keterangan lebih lanjut, klik [tampil] di bagian kanan. Mengganti markah HTML dengan markah wiki bila dimungkinkan. Tambahkan pranala wiki. Bila dirasa perlu, buatlah pautan ke artikel wiki lainnya dengan cara menambahkan [[ dan ]] pada kata yang bersangkutan (lihat WP:LINK untuk keterangan lebih lanjut...

 

Première cohabitation

Si ce bandeau n'est plus pertinent, retirez-le. Cliquez ici pour en savoir plus. Cet article ne cite pas suffisamment ses sources (décembre 2015). Si vous disposez d'ouvrages ou d'articles de référence ou si vous connaissez des sites web de qualité traitant du thème abordé ici, merci de compléter l'article en donnant les références utiles à sa vérifiabilité et en les liant à la section « Notes et références » En pratique : Quelles sources sont attendues ? ...

Magistrates Court of the Australian Capital Territory

Magistrates Court of the Australian Capital TerritoryThe Magistrates Court Building located in Civic, Canberra, completed in 1996.35°16′49″S 149°07′37″E / 35.280385°S 149.127023°E / -35.280385; 149.127023Established25 November 1930 (1930-11-25) (as the Court of Petty Sessions)[1]1 February 1986 (1986-02-01) (as the Magistrates Court)[1]JurisdictionAustralian Capital TerritoryJervis Bay TerritoryAustralian Antar...

 

Cucuk-duri

Cucuk duri Acanthorhynchus Eastern spinebill (Acanthorhynchus tenuirostris)TaksonomiKerajaanAnimaliaFilumChordataKelasAvesOrdoPasseriformesFamiliMeliphagidaeGenusAcanthorhynchus Gould, 1837 SpeciesAcanthorhynchus superciliosus Acanthorhynchus tenuirostrislbs Cucuk-duri adalah nama yang diberikan kepada dua anggota keluarga pemakan madu, keduanya dalam genus Acanthorhynchus, yang merupakan bahasa Latin untuk paruh duri. Panjangnya sekitar 15 sentimeter, berwarna hitam, putih dan kastanye, deng...

 

Christian Perronne

Pour les articles ayant des titres homophones, voir Perrone, Peronne et Pérronnes. Christian PerronneFonctionsVice-présidentFédération française contre les maladies vectorielles à tiques (d)jusqu'en 2020Vice-présidentBonSens.org (d)BiographieNaissance 19 mars 1955 (69 ans)AngersNationalité françaiseFormation Université Paris-Diderot (docteur en médecine) (1985)Université Paris-Diderot (doctorat) (1992)Activités Médecin, professeur des universités-praticien hospitalier, é...

Talus bone

One of the foot bones that forms the tarsus Talus boneAnatomy of the right footSubtalar Joint, viewed from an angle between lateral and frontal.DetailsIdentifiersLatinos talus, astragalusMeSHD013628TA98A02.5.10.001TA21448FMA9708Anatomical terms of bone[edit on Wikidata] The talus (/ˈteɪləs/; Latin for ankle[1] or ankle bone;[2] pl.: tali), talus bone, astragalus (/əˈstræɡələs/), or ankle bone is one of the group of foot bones known as the tarsus. The tarsus forms ...

 

Halt and Catch Fire (TV series)

American period drama television series Halt and Catch FireGenrePeriod dramaCreated by Christopher Cantwell Christopher C. Rogers Starring Lee Pace Scoot McNairy Mackenzie Davis Kerry Bishé Toby Huss Aleksa Palladino Theme music composerTrentemøllerComposerPaul HaslingerCountry of originUnited StatesOriginal languageEnglishNo. of seasons4No. of episodes40 (list of episodes)ProductionExecutive producers Christopher Cantwell Christopher C. Rogers Jonathan Lisco Mark Johnson Melissa Bernstein ...

 

Europol

Badan Uni Eropa untuk Kerja Sama Penegakan HukumEuropean Union Agency for Law Enforcement CooperationMarkas Europol di Den Haag, BelandaInformasi lembagaDibentuk1 Oktober 1998Wilayah hukum Uni EropaKantor pusat Eisenhowerlaan 73, Den Haag, BelandaPegawai1,065 (2016)Anggaran tahunan€116.4 juta (2017)Situs webEuropol.europa.eu European Union Agency for Law Enforcement Cooperation (bahasa Indonesia: Badan Uni Eropa untuk Kerja Sama Penegakan Hukum) disingkat Europol merupakan badan kh...

拉米兹·阿利雅

拉米兹·阿利雅Ramiz Alia第1任阿尔巴尼亚總統任期1991年4月30日—1992年4月9日继任萨利·贝里沙阿尔巴尼亚人民议会主席团主席任期1982年11月22日—1991年4月30日前任哈奇·列希继任转任总统阿尔巴尼亚劳动党第一书记任期1985年4月13日—1991年5月4日前任恩维尔·霍查继任无（政党解散） 个人资料出生(1925-10-18)1925年10月18日 阿尔巴尼亚斯库台逝世2011年10月17日(2011歲—10—17)（85�...

 

Tokyo Ghoul

Japanese manga series by Sui Ishida Not to be confused with Tokyo Ghost. Tokyo GhoulFirst tankōbon volume cover, featuring Ken Kaneki東京喰種（トーキョーグール）(Tōkyō Gūru)GenreDark fantasy[1]Supernatural thriller[2] MangaWritten bySui IshidaPublished byShueishaEnglish publisherNA: Viz MediaImprintYoung Jump ComicsMagazineWeekly Young JumpDemographicSeinenOriginal runSeptember 8, 2011 – September 18, 2014Volumes14 (List of volumes) Further inform...

 

تزلج الرولر السريع

يفتقر محتوى هذه المقالة إلى الاستشهاد بمصادر. فضلاً، ساهم في تطوير هذه المقالة من خلال إضافة مصادر موثوق بها. أي معلومات غير موثقة يمكن التشكيك بها وإزالتها. (يناير 2021) هذه مقالة غير مراجعة. ينبغي أن يزال هذا القالب بعد أن يراجعها محرر؛ إذا لزم الأمر فيجب أن توسم المقالة بقوا...

الأناركية في بيلاروس

جزء من سلسلة مقالات حولاللاسلطوية الفكر رأسمالية مسيحية جمعية إسلامية شيوعية بيئية أنثوية خضراء فردية تبادلية بدائية اجتماعية أو اشتراكية تعاونية او نقابية في الثقافة الدين المجتمع الفنون تاريخ النقد التعليم المبادئ النظرية الأصول الاقتصاد الرأسمالية الماركسية بدون ص�...

 

List of Bangladeshi films of 2007

This article needs additional citations for verification. Please help improve this article by adding citations to reliable sources. Unsourced material may be challenged and removed.Find sources: List of Bangladeshi films of 2007 – news · newspapers · books · scholar · JSTOR (June 2020) (Learn how and when to remove this message) Cinema of Bangladesh List of Bangladeshi films 1928–1947 India 1948–1958 East Pakistan 1959–1970 East Pakistan 1959 19...

 

John Stevenson

Questa voce sull'argomento registi britannici è solo un abbozzo. Contribuisci a migliorarla secondo le convenzioni di Wikipedia. John Stevenson John Stevenson (Londra, 1958) è un regista, animatore e illustratore britannico. Indice 1 Biografia 2 Filmografia principale 3 Altri progetti 4 Collegamenti esterni Biografia Ha ricevuto la nomination ai Premi Oscar 2009 nella categoria miglior film d'animazione per Kung Fu Panda, in condivisione con Mark Osborne. Filmografia principale 1978-1...

Paul Maynard

British politician Paul MaynardOfficial portrait, 2020Parliamentary Under-Secretary of State for PensionsIn office13 November 2023 – 5 July 2024Prime MinisterRishi SunakPreceded byLaura TrottSucceeded byEmma ReynoldsParliamentary Under-Secretary of State for TransportIn office26 July 2019 – 13 February 2020Prime MinisterBoris JohnsonPreceded byAndrew JonesSucceeded byRachel MacleanIn office16 July 2016 – 9 January 2018Prime MinisterTheresa MayPreceded byClaire...

 

The Adventures of Sharkboy and Lavagirl in 3-D

The Adventures ofSharkboy and LavagirlSutradaraRobert RodriguezProduserElizabeth Avellan Bob Weinstein Harvey WeinsteinDitulis olehRobert Rodriguez Racer RodriguezPemeranCayden Boyd Taylor Dooley Taylor Lautner David ArquetteKristin DavisGeorge LopezPenata musikJohn Debney Graeme Revell Robert RodriguezSinematograferRobert RodriguezPenyuntingRobert RodriguezPerusahaanproduksiTroublemaker StudiosDistributorDimension Films Columbia PicturesTanggal rilis10 Juni 2005Durasi94 menitNegaraAmer...