sphinx

The Sphinx documentation generator

https://github.com/sphinx-doc/sphinx

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
✓
Committers with academic emails
27 of 850 committers (3.2%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (13.5%) to scientific vocabulary

Keywords

docs documentation documentation-tool markdown python restructuredtext sphinx

Keywords from Contributors

closember packaging unit-testing pip templates pallets qt notebook apps syntax-highlighting

Last synced: 6 months ago · JSON representation

Repository

The Sphinx documentation generator

Basic Info

Host: GitHub
Owner: sphinx-doc
License: other
Language: Python
Default Branch: master
Homepage: https://www.sphinx-doc.org/
Size: 99 MB

Statistics

Stars: 7,347
Watchers: 165
Forks: 2,262
Open Issues: 1,300
Releases: 67

Topics

docs documentation documentation-tool markdown python restructuredtext sphinx

Created about 11 years ago · Last pushed 6 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Authors

README.rst

========
 Sphinx
========

.. image:: https://img.shields.io/pypi/v/sphinx.svg
   :target: https://pypi.org/project/Sphinx/
   :alt: Package on PyPI

.. image:: https://github.com/sphinx-doc/sphinx/actions/workflows/main.yml/badge.svg
   :target: https://github.com/sphinx-doc/sphinx/actions/workflows/main.yml
   :alt: Build Status

.. image:: https://readthedocs.org/projects/sphinx/badge/?version=master
   :target: https://www.sphinx-doc.org/
   :alt: Documentation Status

.. image:: https://img.shields.io/badge/License-BSD%202--Clause-blue.svg
   :target: https://opensource.org/licenses/BSD-2-Clause
   :alt: BSD 2 Clause

**Sphinx makes it easy to create intelligent and beautiful documentation.**

Sphinx uses reStructuredText as its markup language, and many of its strengths
come from the power and straightforwardness of reStructuredText and its parsing
and translating suite, the Docutils.

Features
========

* **Output formats**: HTML, PDF, plain text, EPUB, TeX, manual pages, and more
* **Extensive cross-references**: semantic markup and automatic links
  for functions, classes, glossary terms and similar pieces of information
* **Hierarchical structure**: easy definition of a document tree, with automatic
  links to siblings, parents and children
* **Automatic indices**: general index as well as a module index
* **Code highlighting**: automatic highlighting using the Pygments highlighter
* **Templating**: Flexible HTML output using the Jinja 2 templating engine
* **Extension ecosystem**: Many extensions are available, for example for
  automatic function documentation or working with Jupyter notebooks.
* **Language Support**: Python, C, C++, JavaScript, mathematics, and many other
  languages through extensions.

For more information, refer to `the documentation`_.

Installation
============

The following command installs Sphinx from the `Python Package Index`_. You will
need a working installation of Python and pip.

.. code-block:: shell

   pip install -U sphinx

Contributing
============

We appreciate all contributions! Refer to `the contributors guide`_ for
information.

.. _the documentation: https://www.sphinx-doc.org/
.. _the contributors guide: https://www.sphinx-doc.org/en/master/internals/contributing.html
.. _Python Package Index: https://pypi.org/project/Sphinx/

Owner

Name: Sphinx
Login: sphinx-doc
Kind: organization

Website: https://www.sphinx-doc.org
Repositories: 18
Profile: https://github.com/sphinx-doc

Sphinx makes it easy to create intelligent and beautiful documentation

Committers

Last synced: 7 months ago

All Time

Total Commits: 16,341
Total Committers: 850
Avg Commits per committer: 19.225
Development Distribution Score (DDS): 0.705

Past Year

Commits: 995
Committers: 78
Avg Commits per committer: 12.756
Development Distribution Score (DDS): 0.335

Top Committers

Name	Email	Commits
Takeshi KOMIYA	i**a@g**m	4,826
Georg Brandl	g**g@p**g	2,929
Adam Turner	9****r	1,664
jfbu	j**u@f**r	1,121
Takayuki SHIMIZUKAWA	s**a@g**m	707
Jakob Lykke Andersen	J**b@c**k	447
Daniel Neuhäuser	d**h@g**m	189
Stephen Finucane	s**n@t**u	181
Robert Lehmann	m**l@r**e	125
Jacob Mason	j**n@g**m	118
James Addison	5****n	116
Jon Dufresne	j**e@g**m	112
Justus Magin	k**s@p**e	107
Jonathan Waltman	j**n@g**m	101
Juan Luis Cano Rodríguez	j**u@r**g	99
Daniel Eades	d**s@h**m	97
Timotheus Kampik	t**k@g**m	94
Armin Ronacher	a**r@a**m	89
Roland Meister	R**r@l**t	88
Matthias Geier	M**r@g**m	84
Dmitry Shachnev	m****7	81
dependabot[bot]	4****]	79
Yoshiki Shibukawa	y**i@s**p	75
Bénédikt Tran	1****z	73
Chris Sewell	c**l@h**m	67
Adam Dangoor	a**r@g**m	64
Rob Ruana	r**b@r**m	50
Pauli Virtanen	p**v@i**i	48
Tim Hoffmann	2****m	46
Martin Liška	m**a@s**z	37
and 820 more...

Committer Domains (Top 20 + Academic)

redhat.com: 8 python.org: 4 clear-code.com: 3 debian.org: 3 heig-vd.ch: 3 gmx.de: 3 iki.fi: 3 free.fr: 3 posteo.de: 3 mozilla.com: 2 metapensiero.it: 2 nordicsemi.no: 2 passoire.fr: 2 bloomberg.net: 2 microsoft.com: 2 arm.com: 2 nvidia.com: 2 hpe.com: 2 ucsc.edu: 2 diamond.ac.uk: 2 tum.de: 1 nist.gov: 1 ike-dyn.ritsumei.ac.jp: 1 cern.ch: 1 abou-samra.fr: 1 berkeley.edu: 1 imperial.ac.uk: 1 mit.edu: 1 stanford.edu: 1 ieee.org: 1 ethz.ch: 1 inria.fr: 1 umich.edu: 1 pcbe15213.cern.ch: 1 cmu.edu: 1 purdue.edu: 1 epfl.ch: 1 upc.edu: 1 ssec.wisc.edu: 1 nyu.edu: 1 ligo.org: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 1,387
Total pull requests: 2,629
Average time to close issues: over 1 year
Average time to close pull requests: about 2 months
Total issue authors: 837
Total pull request authors: 288
Average comments per issue: 3.47
Average comments per pull request: 1.94
Merged pull requests: 1,745
Bot issues: 3
Bot pull requests: 332

Past Year

Issues: 293
Pull requests: 1,042
Average time to close issues: 7 days
Average time to close pull requests: 5 days
Issue authors: 218
Pull request authors: 101
Average comments per issue: 1.46
Average comments per pull request: 0.91
Merged pull requests: 663
Bot issues: 1
Bot pull requests: 231

View more stats

Top Authors

Issue Authors

shimizukawa (74)
jayaddison (54)
AA-Turner (41)
jfbu (37)
picnixz (25)
mgeier (18)
danieleades (15)
dbitouze (10)
timhoffm (9)
pique-b (9)
chrisjsewell (9)
kloczek (8)
tk0miya (8)
choldgraf (7)
dylanh724 (6)

Pull Request Authors

AA-Turner (565)
dependabot[bot] (318)
jayaddison (269)
picnixz (149)
danieleades (122)
adamtheturtle (120)
chrisjsewell (120)
jfbu (103)
timhoffm (75)
DimitriPapadopoulos (71)
hugovk (21)
rffontenelle (21)
n-peugnet (20)
wlach (19)
SilverRainZ (17)

Top Labels

Issue Labels

type:bug (556) type:proposal (205) type:enhancement (175) extensions:autodoc (111) extensions:napoleon (67) builder:latex (56) help wanted (52) type:docs (40) html search (39) extensions (33) builder:html (30) extensions:autosummary (26) type:tests (25) builder:linkcheck (24) type:question (24) extensions:intersphinx (21) type:regression (20) extensions:graphviz (19) awaiting:response (18) internals:config (18) markup (17) html theme (17) internals:refactoring (14) internals:internationalisation (13) internals:toctree (13) python (13) domains:py (13) i18n (12) api:cmdline (12) builder:gettext (11)

Pull Request Labels

dependencies (336) python (304) internals:refactoring (301) internals:typing (171) type:docs (116) type:tests (109) html search (88) type:bug (80) builder:latex (74) extensions:autodoc (71) type:enhancement (68) type:proposal (57) internals:config (55) extensions:intersphinx (51) javascript (48) github_actions (40) builder:html (37) internals:other (37) builder:linkcheck (36) type:performance (28) markup (27) DO NOT MERGE (27) extensions:autosummary (26) type:regression (25) domains:py (25) i18n (24) extensions:napoleon (24) html theme (21) builder (20) priority:low (19)

Packages

Total packages: 5
Total downloads:
- pypi 57,831,755 last-month
Total docker downloads: 434,812,231

Total dependent packages: 7,522
(may contain duplicates)
Total dependent repositories: 72,977
(may contain duplicates)
Total versions: 546
Total maintainers: 4

pypi.org: sphinx

Python documentation generator

Homepage: https://www.sphinx-doc.org/
Documentation: https://www.sphinx-doc.org/
License: other
Latest release: 8.3.0
published 12 months ago

Versions: 229
Dependent Packages: 7,351
Dependent Repositories: 68,751
Downloads: 57,831,742 Last month
Docker Downloads: 434,812,231

Rankings

Dependent packages count: 0.0%

Dependent repos count: 0.0%

Downloads: 0.1%

Average: 0.3%

Docker downloads count: 0.3%

Forks count: 0.6%

Stargazers count: 0.8%

Maintainers (3)

tk0miya AA-Turner Sphinx

Last synced: 6 months ago

conda-forge.org: sphinx

Sphinx makes it easy to create intelligent and beautiful documentation. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.

Homepage: https://www.sphinx-doc.org/
License: BSD-2-Clause
Latest release: 5.3.0
published over 3 years ago

Versions: 90
Dependent Packages: 162
Dependent Repositories: 2,112

Rankings

Dependent repos count: 0.2%

Dependent packages count: 0.4%

Average: 2.1%

Forks count: 2.9%

Stargazers count: 4.7%

Last synced: 6 months ago

proxy.golang.org: github.com/sphinx-doc/sphinx

Documentation: https://pkg.go.dev/github.com/sphinx-doc/sphinx#section-documentation
License: other
Latest release: v8.2.3+incompatible
published 12 months ago

Versions: 179
Dependent Packages: 0
Dependent Repositories: 1

Rankings

Forks count: 0.6%

Stargazers count: 0.9%

Average: 3.7%

Dependent repos count: 4.8%

Dependent packages count: 8.5%

Last synced: 6 months ago

anaconda.org: sphinx

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation, written by Georg Brandl and licensed under the BSD license. It was originally created for the new Python documentation, and it has excellent facilities for the documentation of Python projects, but C/C++ is already supported as well, and it is planned to add special support for other languages as well.

Homepage: https://www.sphinx-doc.org
License: BSD-2-Clause
Latest release: 8.2.3
published 10 months ago

Versions: 47
Dependent Packages: 9
Dependent Repositories: 2,112

Rankings

Dependent repos count: 1.4%

Average: 6.8%

Dependent packages count: 7.0%

Forks count: 7.6%

Stargazers count: 11.2%

Last synced: 6 months ago

pypi.org: gxsphinx

Python documentation generator

Homepage: http://sphinx-doc.org/
Documentation: https://gxsphinx.readthedocs.io/
License: BSD
Latest release: 1.0.0
published over 5 years ago

Versions: 1
Dependent Packages: 0
Dependent Repositories: 1
Downloads: 13 Last month

Rankings

Forks count: 0.3%

Stargazers count: 0.4%

Dependent packages count: 7.4%

Average: 13.1%

Dependent repos count: 22.2%

Downloads: 35.1%

Maintainers (1)

rapha

Last synced: 6 months ago

Dependencies

.github/workflows/builddoc.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite

.github/workflows/coverage.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite
codecov/codecov-action v3 composite

.github/workflows/create-release.yml actions

actions/checkout v3 composite
softprops/action-gh-release v1 composite

.github/workflows/latex.yml actions

actions/checkout v3 composite

.github/workflows/lint.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite

.github/workflows/lock.yml actions

dessant/lock-threads v3 composite

.github/workflows/main.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite
deadsnakes/action v2.1.1 composite

.github/workflows/nodejs.yml actions

GabrielBB/xvfb-action v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/transifex.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite
peter-evans/create-pull-request v4 composite

package-lock.json npm

128 dependencies

package.json npm

jasmine-core ^3.4.0 development
karma ^6.3.16 development
karma-firefox-launcher ^2.0.0 development
karma-jasmine ^4.0.0 development