Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/12rambau/sphinx-social

A Sphinx directive for social media embeds

https://github.com/12rambau/sphinx-social

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

Repository

A Sphinx directive for social media embeds

Basic Info
  • Host: GitHub
  • Owner: 12rambau
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 2.05 MB
Statistics
  • Stars: 2
  • Watchers: 3
  • Forks: 2
  • Open Issues: 0
  • Releases: 0
Created about 3 years ago · Last pushed about 3 years ago
Metadata Files
Readme Contributing License Code of conduct Authors

README.rst 

sphinx-social
=============

.. image:: https://img.shields.io/badge/License-MIT-yellow.svg?logo=opensourceinitiative&logoColor=white
    :target: LICENSE
    :alt: License: MIT

.. image:: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?logo=git&logoColor=white
   :target: https://conventionalcommits.org
   :alt: conventional commit

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :target: https://github.com/psf/black
   :alt: Black badge

.. image:: https://img.shields.io/badge/code_style-prettier-ff69b4.svg?logo=prettier&logoColor=white
   :target: https://github.com/prettier/prettier
   :alt: prettier badge

.. image:: https://img.shields.io/badge/pre--commit-active-yellow?logo=pre-commit&logoColor=white
    :target: https://pre-commit.com/
    :alt: pre-commit

.. image:: https://img.shields.io/pypi/v/sphinx-social?color=blue&logo=pypi&logoColor=white
    :target: https://pypi.org/project/sphinx-social/
    :alt: PyPI version

.. image:: https://img.shields.io/github/actions/workflow/status/12rambau/sphinx-social/unit.yaml?logo=github&logoColor=white
    :target: https://github.com/12rambau/sphinx-social/actions/workflows/unit.yaml
    :alt: build

.. image:: https://img.shields.io/codecov/c/github/12rambau/sphinx-social?logo=codecov&logoColor=white
    :target: https://codecov.io/gh/12rambau/sphinx-social
    :alt: Test Coverage

.. image:: https://img.shields.io/readthedocs/sphinx-social?logo=readthedocs&logoColor=white
    :target: https://sphinx-social.readthedocs.io/en/latest/
    :alt: Documentation Status

.. image:: https://img.shields.io/badge/all_contributors-0-orange.svg
    :alt: All contributors
    :target: AUTHORS.rst

Overview
--------

Ths extention provides support to embed social media posts in your Sphinx based documentation.

each service is served by a custom directive like :

.. code-block:: rst

    .. twitter:: https://twitter.com/github/status/1638541174611779584

We currently support the following services:
- facebook
- linkedin
- mastodon
- twitter

If you want to see your favorite Social media in this list, please mention them in our `issue tracker `__.

Credits
-------

Initialy posted as a concept idea by `@choldgraf `__ on his `blog `__.

This package was created with `Cookiecutter `__ and the `12rambau/pypackage `__ project template.

Owner

  • Name: Rambaud Pierrick
  • Login: 12rambau
  • Kind: user
  • Location: Rome, Italy
  • Company: FAO @openforis

Materials engineer turned Software Engineer and Python enthusiast for Earth Observation applications

GitHub Events

Total
  • Fork event: 1
Last Year
  • Fork event: 1

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 2
  • Total pull requests: 2
  • Average time to close issues: about 4 hours
  • Average time to close pull requests: about 2 hours
  • Total issue authors: 1
  • Total pull request authors: 2
  • Average comments per issue: 3.0
  • Average comments per pull request: 0.5
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • kolibril13 (1)
Pull Request Authors
  • kolibril13 (1)
  • 12rambau (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 56 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 1
  • Total maintainers: 1
pypi.org: sphinx-social

A Sphinx directive for social media embeds

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 56 Last month
Rankings
Dependent packages count: 10.0%
Dependent repos count: 21.7%
Forks count: 29.8%
Stargazers count: 31.9%
Average: 33.3%
Downloads: 73.3%
Maintainers (1)
borntobealive
Last synced: 10 months ago