Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/codex-test-repos/sphinx-doc__sphinx-10673

https://github.com/codex-test-repos/sphinx-doc__sphinx-10673

Science Score: 26.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
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (13.4%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: codex-test-repos
  • License: other
  • Language: Python
  • Default Branch: main
  • Size: 4.22 MB
Statistics
  • Stars: 0
  • Watchers: 0
  • Forks: 0
  • Open Issues: 7
  • Releases: 0
Created about 1 year ago · Last pushed about 1 year 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 `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:: sh

   pip install -U sphinx

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

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

Release signatures
==================

Releases are signed with following keys:

* `498D6B9E `_
* `5EBA0E07 `_
* `61F0FB52 `_

.. _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: codex-test-repos
  • Login: codex-test-repos
  • Kind: organization

GitHub Events

Total
  • Delete event: 1
  • Issue comment event: 2
  • Push event: 1
  • Pull request event: 5
  • Create event: 5
Last Year
  • Delete event: 1
  • Issue comment event: 2
  • Push event: 1
  • Pull request event: 5
  • Create event: 5

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 0
  • Total pull requests: 4
  • Average time to close issues: N/A
  • Average time to close pull requests: 3 months
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.5
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 4
Past Year
  • Issues: 0
  • Pull requests: 4
  • Average time to close issues: N/A
  • Average time to close pull requests: 3 months
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.5
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 4
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • dependabot[bot] (4)
Top Labels
Issue Labels
Pull Request Labels
dependencies (4) github_actions (4)

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/docutils-latest.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 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
setup.py pypi
  • Jinja2 >=3.0
  • Pygments >=2.12
  • alabaster >=0.7,<0.8
  • babel >=2.9
  • colorama >=0.4.5
  • docutils >=0.14,<0.20
  • imagesize >=1.3
  • importlib-metadata >=4.8
  • packaging >=21.0
  • requests >=2.5.0
  • snowballstemmer >=2.0
  • sphinxcontrib-applehelp *
  • sphinxcontrib-devhelp *
  • sphinxcontrib-htmlhelp >=2.0.0
  • sphinxcontrib-jsmath *
  • sphinxcontrib-qthelp *
  • sphinxcontrib-serializinghtml >=1.1.5
tests/roots/test-pycode-egg/src/setup.py pypi
tests/roots/test-setup/setup.py pypi
tests/roots/test-theming/setup.py pypi