.. |.configuration/configuring| replace:: Extension Configuration
.. _.configuration/configuring: https://sphinx-readme.readthedocs.io/en/latest/configuration/configuring.html
.. |.html_baseurl| replace:: ``html_baseurl``
.. _.html_baseurl: https://sphinx-readme.readthedocs.io/en/latest/configuration/configuring.html#confval-html_baseurl
.. |.html_context| replace:: ``html_context``
.. _.html_context: https://sphinx-readme.readthedocs.io/en/latest/configuration/configuring.html#confval-html_context
.. |.~.parse_intersphinx_nodes| replace:: ``parse_intersphinx_nodes()``
.. _.~.parse_intersphinx_nodes: https://github.com/TDKorn/sphinx-readme/blob/v1.2.1/sphinx_readme/parser.py#L256-L293
.. |.read the docs user documentation+guides/edit-source-links-sphinx-colon-github+HTML Context Settings| replace:: HTML Context Settings
.. _.read the docs user documentation+guides/edit-source-links-sphinx-colon-github+HTML Context Settings: https://docs.readthedocs.io/en/stable/guides/edit-source-links-sphinx.html#github
.. |.readme_docs_url_type| replace:: ``readme_docs_url_type``
.. _.readme_docs_url_type: https://sphinx-readme.readthedocs.io/en/latest/configuration/configuring.html#confval-readme_docs_url_type
.. |.readme_inline_markup| replace:: ``readme_inline_markup``
.. _.readme_inline_markup: https://sphinx-readme.readthedocs.io/en/latest/configuration/configuring.html#confval-readme_inline_markup
.. |.readme_out_dir+output directory| replace:: ``output directory``
.. _.readme_out_dir+output directory: https://sphinx-readme.readthedocs.io/en/latest/configuration/configuring.html#confval-readme_out_dir
.. |.readme_raw_directive| replace:: ``readme_raw_directive``
.. _.readme_raw_directive: https://sphinx-readme.readthedocs.io/en/latest/configuration/configuring.html#confval-readme_raw_directive
.. |.readme_replace_attrs| replace:: ``readme_replace_attrs``
.. _.readme_replace_attrs: https://sphinx-readme.readthedocs.io/en/latest/configuration/configuring.html#confval-readme_replace_attrs
.. |.readme_src_files| replace:: ``readme_src_files``
.. _.readme_src_files: https://sphinx-readme.readthedocs.io/en/latest/configuration/configuring.html#confval-readme_src_files
.. |.sphinx+html_baseurl| replace:: ``html_baseurl``
.. _.sphinx+html_baseurl: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_baseurl
.. |.sphinx+html_context| replace:: ``html_context``
.. _.sphinx+html_context: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_context
.. |.sphinx+usage/domains/restructuredtext+reStructuredText Domain| replace:: reStructuredText Domain
.. _.sphinx+usage/domains/restructuredtext+reStructuredText Domain: https://www.sphinx-doc.org/en/master/usage/domains/restructuredtext.html
.. |.sphinx+usage/domains/standard+Standard Domain| replace:: Standard Domain
.. _.sphinx+usage/domains/standard+Standard Domain: https://www.sphinx-doc.org/en/master/usage/domains/standard.html
.. |.~.sphinx.domains.python.PythonDomain| replace:: ``PythonDomain``
.. _.~.sphinx.domains.python.PythonDomain: https://www.sphinx-doc.org/en/master/extdev/domainapi.html#sphinx.domains.python.PythonDomain
.. |.~.sphinx.environment.BuildEnvironment| replace:: ``BuildEnvironment``
.. _.~.sphinx.environment.BuildEnvironment: https://www.sphinx-doc.org/en/master/extdev/envapi.html#sphinx.environment.BuildEnvironment
.. |.sphinx.ext.autodoc| replace:: ``sphinx.ext.autodoc``
.. _.sphinx.ext.autodoc: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#module-sphinx.ext.autodoc
.. |.~.sphinx.ext.autodoc| replace:: ``autodoc``
.. _.~.sphinx.ext.autodoc: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#module-sphinx.ext.autodoc
.. |.sphinx.ext.linkcode| replace:: ``sphinx.ext.linkcode``
.. _.sphinx.ext.linkcode: https://www.sphinx-doc.org/en/master/usage/extensions/linkcode.html#module-sphinx.ext.linkcode
.. role:: rst(code)
:class: highlight
.. |env| replace:: |.~.sphinx.environment.BuildEnvironment|_
.. |py_domain| replace:: |.~.sphinx.domains.python.PythonDomain|_
.. |std_domain| replace:: |.sphinx+usage/domains/standard+Standard Domain|_
.. |rst_domain| replace:: |.sphinx+usage/domains/restructuredtext+reStructuredText Domain|_
.. meta::
:author: Adam Korn
:title: Sphinx README - Generate README.rst That Renders Beautifully on GitHub, PyPi, GitLab, BitBucket
:description: Sphinx extension to generate reStructuredText README.rst files that render beautifully on GitHub, PyPi, GitLab, BitBucket
Sphinx README - Generate Beautiful README.rst for GitHub, PyPi, GitLab, BitBucket
--------------------------------------------------------------------------------------
.. image:: https://raw.githubusercontent.com/TDKorn/sphinx-readme/v1.2.1/docs/source/_static/logo_transparent.png
:alt: Sphinx README: Generate Beautiful reStructuredText README.rst for GitHub, PyPi, GitLab, BitBucket
:align: center
:width: 25%
A Sphinx extension to generate ``README.rst`` files that render beautifully on GitHub, PyPi, GitLab, BitBucket
.. |RTD| replace:: **Explore the docs »**
.. _RTD: https://sphinx-readme.readthedocs.io/en/latest/
|RTD|_
|
.. image:: https://img.shields.io/pypi/v/sphinx-readme?color=eb5202
:target: https://pypi.org/project/sphinx-readme
:alt: PyPI Project for Sphinx README: Generate Beautiful reStructuredText README.rst for GitHub, PyPi, GitLab, BitBucket
.. image:: https://img.shields.io/badge/GitHub-sphinx--readme-4f1abc
:target: https://github.com/tdkorn/sphinx-readme
:alt: GitHub Repository for Sphinx README: Generate Beautiful reStructuredText README.rst for GitHub, PyPi, GitLab, BitBucket
.. image:: https://static.pepy.tech/personalized-badge/sphinx-readme?period=total&units=none&left_color=grey&right_color=blue&left_text=Downloads
:target: https://pepy.tech/project/sphinx-readme
:alt: Downloads for Sphinx README
.. image:: https://readthedocs.org/projects/sphinx-readme/badge/?version=latest
:target: https://sphinx-readme.readthedocs.io/en/latest/?badge=latest
:alt: Documentation for Sphinx README: Generate Beautiful reStructuredText README.rst for GitHub, PyPi, GitLab, BitBucket
.. image:: https://img.shields.io/github/actions/workflow/status/TDKorn/sphinx-readme/tests.yml?label=build&color=33ce57
:target: https://github.com/TDKorn/sphinx-readme/actions/workflows/tests.yml
:alt: Build Status
.. image:: https://codecov.io/gh/TDKorn/sphinx-readme/graph/badge.svg?token=RZCUCGIU0Q
:target: https://codecov.io/gh/TDKorn/sphinx-readme
:alt: Code Coverage
|
About Sphinx README
~~~~~~~~~~~~~~~~~~~~~~~
.. list-table::
:header-rows: 1
* - 📚 What's Sphinx README?
* - ``sphinx_readme`` is a ``reStructuredText`` parser that uses Sphinx
to generate ``rst`` files that render beautifully on
GitHub, PyPi, GitLab, and BitBucket.
**With** ``sphinx_readme`` **, there's no need to rewrite your** ``README.rst`` **as a** ``README.md`` **file**
Files generated by ``sphinx_readme`` have nearly identical appearance and functionality
as ``html`` builds, including |.sphinx.ext.autodoc|_ cross-references!
|
.. image:: https://raw.githubusercontent.com/TDKorn/sphinx-readme/v1.2.1/docs/source/_static/demo/demo.gif
:alt: Demonstration of how reStructuredText README.rst files generated by Sphinx README render on GitHub, PyPi, GitLab, BitBucket
:width: 75%
📋 Features
~~~~~~~~~~~~
``sphinx_readme`` adds support for the following ``sphinx`` and ``docutils`` directives and features:
* |.sphinx.ext.autodoc|_ cross-references (``:mod:``, ``:class:``, ``:meth:``, ``:func:``, and ``:attr:``)
* Standard cross-reference roles (``:doc:`` and ``:ref:``)
* Generic and Specific Admonitions
* Only directives
* Toctrees
* Rubrics
* Images
⚙ Installation
~~~~~~~~~~~~~~~~
Install using pip::
pip install sphinx-readme
Add the extension to your ``conf.py``:
.. code-block:: python
extensions = [
'sphinx_readme',
]
🔧 Configuration
~~~~~~~~~~~~~~~~~
Please see |.configuration/configuring|_ for full documentation on configuration variables
Mandatory ``conf.py`` Values
==================================
|.html_context|_
A dictionary containing info about your repository (|.sphinx+html_context|_)
**Type:** ``dict``
* At minimum, the username and repository name must be specified
* Please see |.read the docs user documentation+guides/edit-source-links-sphinx-colon-github+HTML Context Settings|_
to determine the correct dictionary keys for your hosting platform
|
|.html_baseurl|_
The base URL which points to the root of the HTML documentation (|.sphinx+html_baseurl|_)
**Type:** ``str``
|
|.readme_src_files|_
An individual/list of ``rst`` source files to parse, or a dictionary of source files mapped to output files
**Type:** ``Union[str, List[str], Dict[str,str]]``
.. list-table::
:header-rows: 1
* - 📢 Important
* - Filepaths should be specified relative to the source directory
and |.readme_out_dir+output directory|_
|
|.readme_docs_url_type|_
The documentation source to link to when resolving |.~.sphinx.ext.autodoc|_ cross-references
**Type:** ``str``
Must be either ``"code"`` or ``"html"``
* ``"code"``: uses |.sphinx.ext.linkcode|_ to replace references with links to highlighted source code
**Example**: |.~.parse_intersphinx_nodes|_
* ``"html"``: replaces references with links to HTML documentation entries
**Example**: |parse_intersphinx_nodes_html|_
.. list-table::
:header-rows: 1
* - 📝 Note
* - If set to ``code``, non-external :code:`:attr:` cross-references will not be replaced with links
* Instead, they'll be replaced with ``inline literals`` or left as is
* Please see |.readme_replace_attrs|_ and |.readme_inline_markup|_
.. |parse_intersphinx_nodes_html| replace:: ``parse_intersphinx_nodes()``
.. _parse_intersphinx_nodes_html: http://sphinx-readme.readthedocs.io/en/latest/parser.html#sphinx_readme.parser.READMEParser.parse_intersphinx_nodes
Sample ``conf.py``
~~~~~~~~~~~~~~~~~~~
.. code-block:: python
extensions = [
"sphinx_readme",
]
html_context = {
'display_github': True,
'github_user': 'TDKorn',
'github_repo': 'sphinx-readme',
}
html_baseurl = "https://sphinx-readme.readthedocs.io/en/latest"
readme_src_files = "README.rst"
readme_docs_url_type = "code"
.. list-table::
:header-rows: 1
* - 📢 Important
* - For platforms that don't support the ``raw`` directive (PyPi, GitLab, and BitBucket),
be sure to disable |.readme_raw_directive|_:
.. code-block:: python
readme_raw_directive = False
📚 Documentation
~~~~~~~~~~~~~~~~
Full documentation can be found on |docs|_
.. |docs| replace:: ``ReadTheDocs``
.. _docs: https://sphinx-readme.readthedocs.io/en/latest
Raw data
{
"_id": null,
"home_page": "https://github.com/tdkorn/sphinx-readme",
"name": "sphinx-readme",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "sphinx,docutils,sphinx-extension,sphinx-contrib,reStructuredText,rst,reST,parser,rst-parser,README.rst,README,autodoc,linkcode",
"author": "Adam Korn",
"author_email": "hello@dailykitten.net",
"download_url": "https://files.pythonhosted.org/packages/93/f9/376c6bea802b479092d6dd4a01535fac8a2ceac1dc54769062b022247222/sphinx-readme-1.2.1.tar.gz",
"platform": null,
"description": ".. |.configuration/configuring| replace:: Extension Configuration\n.. _.configuration/configuring: https://sphinx-readme.readthedocs.io/en/latest/configuration/configuring.html\n.. |.html_baseurl| replace:: ``html_baseurl``\n.. _.html_baseurl: https://sphinx-readme.readthedocs.io/en/latest/configuration/configuring.html#confval-html_baseurl\n.. |.html_context| replace:: ``html_context``\n.. _.html_context: https://sphinx-readme.readthedocs.io/en/latest/configuration/configuring.html#confval-html_context\n.. |.~.parse_intersphinx_nodes| replace:: ``parse_intersphinx_nodes()``\n.. _.~.parse_intersphinx_nodes: https://github.com/TDKorn/sphinx-readme/blob/v1.2.1/sphinx_readme/parser.py#L256-L293\n.. |.read the docs user documentation+guides/edit-source-links-sphinx-colon-github+HTML Context Settings| replace:: HTML Context Settings\n.. _.read the docs user documentation+guides/edit-source-links-sphinx-colon-github+HTML Context Settings: https://docs.readthedocs.io/en/stable/guides/edit-source-links-sphinx.html#github\n.. |.readme_docs_url_type| replace:: ``readme_docs_url_type``\n.. _.readme_docs_url_type: https://sphinx-readme.readthedocs.io/en/latest/configuration/configuring.html#confval-readme_docs_url_type\n.. |.readme_inline_markup| replace:: ``readme_inline_markup``\n.. _.readme_inline_markup: https://sphinx-readme.readthedocs.io/en/latest/configuration/configuring.html#confval-readme_inline_markup\n.. |.readme_out_dir+output directory| replace:: ``output directory``\n.. _.readme_out_dir+output directory: https://sphinx-readme.readthedocs.io/en/latest/configuration/configuring.html#confval-readme_out_dir\n.. |.readme_raw_directive| replace:: ``readme_raw_directive``\n.. _.readme_raw_directive: https://sphinx-readme.readthedocs.io/en/latest/configuration/configuring.html#confval-readme_raw_directive\n.. |.readme_replace_attrs| replace:: ``readme_replace_attrs``\n.. _.readme_replace_attrs: https://sphinx-readme.readthedocs.io/en/latest/configuration/configuring.html#confval-readme_replace_attrs\n.. |.readme_src_files| replace:: ``readme_src_files``\n.. _.readme_src_files: https://sphinx-readme.readthedocs.io/en/latest/configuration/configuring.html#confval-readme_src_files\n.. |.sphinx+html_baseurl| replace:: ``html_baseurl``\n.. _.sphinx+html_baseurl: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_baseurl\n.. |.sphinx+html_context| replace:: ``html_context``\n.. _.sphinx+html_context: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_context\n.. |.sphinx+usage/domains/restructuredtext+reStructuredText Domain| replace:: reStructuredText Domain\n.. _.sphinx+usage/domains/restructuredtext+reStructuredText Domain: https://www.sphinx-doc.org/en/master/usage/domains/restructuredtext.html\n.. |.sphinx+usage/domains/standard+Standard Domain| replace:: Standard Domain\n.. _.sphinx+usage/domains/standard+Standard Domain: https://www.sphinx-doc.org/en/master/usage/domains/standard.html\n.. |.~.sphinx.domains.python.PythonDomain| replace:: ``PythonDomain``\n.. _.~.sphinx.domains.python.PythonDomain: https://www.sphinx-doc.org/en/master/extdev/domainapi.html#sphinx.domains.python.PythonDomain\n.. |.~.sphinx.environment.BuildEnvironment| replace:: ``BuildEnvironment``\n.. _.~.sphinx.environment.BuildEnvironment: https://www.sphinx-doc.org/en/master/extdev/envapi.html#sphinx.environment.BuildEnvironment\n.. |.sphinx.ext.autodoc| replace:: ``sphinx.ext.autodoc``\n.. _.sphinx.ext.autodoc: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#module-sphinx.ext.autodoc\n.. |.~.sphinx.ext.autodoc| replace:: ``autodoc``\n.. _.~.sphinx.ext.autodoc: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#module-sphinx.ext.autodoc\n.. |.sphinx.ext.linkcode| replace:: ``sphinx.ext.linkcode``\n.. _.sphinx.ext.linkcode: https://www.sphinx-doc.org/en/master/usage/extensions/linkcode.html#module-sphinx.ext.linkcode\n\n\n\n.. role:: rst(code)\n :class: highlight\n\n.. |env| replace:: |.~.sphinx.environment.BuildEnvironment|_\n.. |py_domain| replace:: |.~.sphinx.domains.python.PythonDomain|_\n.. |std_domain| replace:: |.sphinx+usage/domains/standard+Standard Domain|_\n.. |rst_domain| replace:: |.sphinx+usage/domains/restructuredtext+reStructuredText Domain|_\n\n.. meta::\n :author: Adam Korn\n :title: Sphinx README - Generate README.rst That Renders Beautifully on GitHub, PyPi, GitLab, BitBucket\n :description: Sphinx extension to generate reStructuredText README.rst files that render beautifully on GitHub, PyPi, GitLab, BitBucket\n\nSphinx README - Generate Beautiful README.rst for GitHub, PyPi, GitLab, BitBucket\n--------------------------------------------------------------------------------------\n\n.. image:: https://raw.githubusercontent.com/TDKorn/sphinx-readme/v1.2.1/docs/source/_static/logo_transparent.png\n :alt: Sphinx README: Generate Beautiful reStructuredText README.rst for GitHub, PyPi, GitLab, BitBucket\n :align: center\n :width: 25%\n\n\n\n\n\n\n\n\n\n\n\n\n\nA Sphinx extension to generate ``README.rst`` files that render beautifully on GitHub, PyPi, GitLab, BitBucket\n\n.. |RTD| replace:: **Explore the docs \u00bb**\n.. _RTD: https://sphinx-readme.readthedocs.io/en/latest/\n\n|RTD|_\n\n|\n\n.. image:: https://img.shields.io/pypi/v/sphinx-readme?color=eb5202\n :target: https://pypi.org/project/sphinx-readme\n :alt: PyPI Project for Sphinx README: Generate Beautiful reStructuredText README.rst for GitHub, PyPi, GitLab, BitBucket\n\n.. image:: https://img.shields.io/badge/GitHub-sphinx--readme-4f1abc\n :target: https://github.com/tdkorn/sphinx-readme\n :alt: GitHub Repository for Sphinx README: Generate Beautiful reStructuredText README.rst for GitHub, PyPi, GitLab, BitBucket\n\n.. image:: https://static.pepy.tech/personalized-badge/sphinx-readme?period=total&units=none&left_color=grey&right_color=blue&left_text=Downloads\n :target: https://pepy.tech/project/sphinx-readme\n :alt: Downloads for Sphinx README\n\n.. image:: https://readthedocs.org/projects/sphinx-readme/badge/?version=latest\n :target: https://sphinx-readme.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation for Sphinx README: Generate Beautiful reStructuredText README.rst for GitHub, PyPi, GitLab, BitBucket\n\n.. image:: https://img.shields.io/github/actions/workflow/status/TDKorn/sphinx-readme/tests.yml?label=build&color=33ce57\n :target: https://github.com/TDKorn/sphinx-readme/actions/workflows/tests.yml\n :alt: Build Status\n\n.. image:: https://codecov.io/gh/TDKorn/sphinx-readme/graph/badge.svg?token=RZCUCGIU0Q\n :target: https://codecov.io/gh/TDKorn/sphinx-readme\n :alt: Code Coverage\n\n\n\n|\n\nAbout Sphinx README\n~~~~~~~~~~~~~~~~~~~~~~~\n\n\n.. list-table::\n :header-rows: 1\n \n * - \ud83d\udcda What's Sphinx README?\n * - ``sphinx_readme`` is a ``reStructuredText`` parser that uses Sphinx\n to generate ``rst`` files that render beautifully on\n GitHub, PyPi, GitLab, and BitBucket.\n\n\n\n**With** ``sphinx_readme`` **, there's no need to rewrite your** ``README.rst`` **as a** ``README.md`` **file**\n\nFiles generated by ``sphinx_readme`` have nearly identical appearance and functionality\nas ``html`` builds, including |.sphinx.ext.autodoc|_ cross-references!\n\n|\n\n.. image:: https://raw.githubusercontent.com/TDKorn/sphinx-readme/v1.2.1/docs/source/_static/demo/demo.gif\n :alt: Demonstration of how reStructuredText README.rst files generated by Sphinx README render on GitHub, PyPi, GitLab, BitBucket\n :width: 75%\n\n\n\ud83d\udccb Features\n~~~~~~~~~~~~\n\n``sphinx_readme`` adds support for the following ``sphinx`` and ``docutils`` directives and features:\n\n* |.sphinx.ext.autodoc|_ cross-references (``:mod:``, ``:class:``, ``:meth:``, ``:func:``, and ``:attr:``)\n* Standard cross-reference roles (``:doc:`` and ``:ref:``)\n* Generic and Specific Admonitions\n* Only directives\n* Toctrees\n* Rubrics\n* Images\n\n\n\u2699 Installation\n~~~~~~~~~~~~~~~~\n\nInstall using pip::\n\n pip install sphinx-readme\n\n\nAdd the extension to your ``conf.py``:\n\n.. code-block:: python\n\n extensions = [\n 'sphinx_readme',\n ]\n\n\n\n\ud83d\udd27 Configuration\n~~~~~~~~~~~~~~~~~\n\n\n\n\nPlease see |.configuration/configuring|_ for full documentation on configuration variables\n\n\nMandatory ``conf.py`` Values\n==================================\n\n|.html_context|_\n A dictionary containing info about your repository (|.sphinx+html_context|_)\n\n **Type:** ``dict``\n\n * At minimum, the username and repository name must be specified\n * Please see |.read the docs user documentation+guides/edit-source-links-sphinx-colon-github+HTML Context Settings|_\n to determine the correct dictionary keys for your hosting platform\n\n\n|\n\n|.html_baseurl|_\n The base URL which points to the root of the HTML documentation (|.sphinx+html_baseurl|_)\n\n **Type:** ``str``\n\n\n|\n\n|.readme_src_files|_\n An individual/list of ``rst`` source files to parse, or a dictionary of source files mapped to output files\n\n **Type:** ``Union[str, List[str], Dict[str,str]]``\n\n\n.. list-table::\n :header-rows: 1\n \n * - \ud83d\udce2 Important\n * - Filepaths should be specified relative to the source directory\n and |.readme_out_dir+output directory|_\n\n\n|\n\n|.readme_docs_url_type|_\n The documentation source to link to when resolving |.~.sphinx.ext.autodoc|_ cross-references\n\n **Type:** ``str``\n\n Must be either ``\"code\"`` or ``\"html\"``\n\n * ``\"code\"``: uses |.sphinx.ext.linkcode|_ to replace references with links to highlighted source code\n\n **Example**: |.~.parse_intersphinx_nodes|_\n\n\n * ``\"html\"``: replaces references with links to HTML documentation entries\n\n **Example**: |parse_intersphinx_nodes_html|_\n\n\n.. list-table::\n :header-rows: 1\n \n * - \ud83d\udcdd Note\n * - If set to ``code``, non-external :code:`:attr:` cross-references will not be replaced with links\n\n * Instead, they'll be replaced with ``inline literals`` or left as is\n * Please see |.readme_replace_attrs|_ and |.readme_inline_markup|_\n\n\n\n.. |parse_intersphinx_nodes_html| replace:: ``parse_intersphinx_nodes()``\n.. _parse_intersphinx_nodes_html: http://sphinx-readme.readthedocs.io/en/latest/parser.html#sphinx_readme.parser.READMEParser.parse_intersphinx_nodes\n\n\nSample ``conf.py``\n~~~~~~~~~~~~~~~~~~~\n\n.. code-block:: python\n\n extensions = [\n \"sphinx_readme\",\n ]\n\n html_context = {\n 'display_github': True,\n 'github_user': 'TDKorn',\n 'github_repo': 'sphinx-readme',\n }\n\n html_baseurl = \"https://sphinx-readme.readthedocs.io/en/latest\"\n\n readme_src_files = \"README.rst\"\n\n readme_docs_url_type = \"code\"\n\n\n\n\n.. list-table::\n :header-rows: 1\n \n * - \ud83d\udce2 Important\n * - For platforms that don't support the ``raw`` directive (PyPi, GitLab, and BitBucket),\n be sure to disable |.readme_raw_directive|_:\n\n .. code-block:: python\n\n readme_raw_directive = False\n\n\n\n\n\ud83d\udcda Documentation\n~~~~~~~~~~~~~~~~\n\nFull documentation can be found on |docs|_\n\n\n.. |docs| replace:: ``ReadTheDocs``\n.. _docs: https://sphinx-readme.readthedocs.io/en/latest\n\n\n\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Generate Beautiful reStructuredText README.rst for GitHub, PyPi, GitLab, BitBucket",
"version": "1.2.1",
"project_urls": {
"Download": "https://github.com/TDKorn/sphinx-readme/tarball/main",
"Homepage": "https://github.com/tdkorn/sphinx-readme"
},
"split_keywords": [
"sphinx",
"docutils",
"sphinx-extension",
"sphinx-contrib",
"restructuredtext",
"rst",
"rest",
"parser",
"rst-parser",
"readme.rst",
"readme",
"autodoc",
"linkcode"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f6648aee4fc143888c3f46a43e0bb2cf7e089a7e02ca5ffa22cda1ff37848689",
"md5": "e3060fab80b8de4a24d251505c9e8b5e",
"sha256": "94458b505ef1c8a0589431d097d225f2e6ab67785c04315d1870c4f537c766e4"
},
"downloads": -1,
"filename": "sphinx_readme-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e3060fab80b8de4a24d251505c9e8b5e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 28099,
"upload_time": "2024-02-05T02:49:28",
"upload_time_iso_8601": "2024-02-05T02:49:28.242387Z",
"url": "https://files.pythonhosted.org/packages/f6/64/8aee4fc143888c3f46a43e0bb2cf7e089a7e02ca5ffa22cda1ff37848689/sphinx_readme-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "93f9376c6bea802b479092d6dd4a01535fac8a2ceac1dc54769062b022247222",
"md5": "adfecf4032b305cd9b88f834e7cb4774",
"sha256": "0629b48d5bcefb20b5b733b6a2961d712acf80ba034db6a8bc75aaa66432914d"
},
"downloads": -1,
"filename": "sphinx-readme-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "adfecf4032b305cd9b88f834e7cb4774",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27549,
"upload_time": "2024-02-05T02:49:30",
"upload_time_iso_8601": "2024-02-05T02:49:30.206189Z",
"url": "https://files.pythonhosted.org/packages/93/f9/376c6bea802b479092d6dd4a01535fac8a2ceac1dc54769062b022247222/sphinx-readme-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-05 02:49:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tdkorn",
"github_project": "sphinx-readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "sphinx",
"specs": [
[
">=",
"1.8"
]
]
}
],
"lcname": "sphinx-readme"
}
JSON
