furo50


Namefuro50 JSON
Version 1.0.0a1 PyPI version JSON
download
home_pageNone
SummarySphinx Extension that turns furo theme into CS50's theme.
upload_time2024-08-28 15:44:36
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseNone
keywords documentation sphinx cs50
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <h1 align="center">Furo50</h1>
<p align="center">
  A sphinx extenstion that turns <a href="https://github.com/pradyunsg/furo">Furo theme</a> into <a href="https://cs50.harvard.edu/college/2019/fall/">CS50</a>'s theme.
</p>

<p align="center">
    <a href="https://github.com/ABD-01/furo50/actions/workflows/tests.yml?branch=master"><img src="https://github.com/ABD-01/furo50/actions/workflows/tests.yml/badge.svg?branch=master" alt="Tests"></a>
    &emsp;
    <a href="https://github.com/ABD-01/furo50/actions/workflows/docs.yml?branch=master"><img src="https://github.com/ABD-01/furo50/actions/workflows/docs.yml/badge.svg?branch=master" alt="Docs"></a>
    &emsp;
    <img src="https://raw.githubusercontent.com/ABD-01/furo50/master/docs/_static/coverage.svg" alt="Coverage">
    &emsp;
    <a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code style: black"></a>
    &emsp;
    <a href="https://www.gnu.org/licenses/gpl-3.0"><img src="https://img.shields.io/badge/License-GPLv3-blue.svg" alt="License: GPL v3"></a>
</p>
<p align="center">
    <a href="https://pypi.org/project/furo50/"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/furo50"></a>
    &emsp;
    <a href="https://pypi.org/project/furo50/"><img alt="PyPI - Pyversions" src="https://img.shields.io/pypi/pyversions/furo50"></a>
</p>

<!-- [![Tests](https://github.com/ABD-01/furo50/actions/workflows/tests.yml/badge.svg?branch=master)](https://github.com/ABD-01/furo50/actions/workflows/tests.yml) &emsp; ![](docs/_static/coverage.svg) &emsp; [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) -->

<!-- [![Documentation](https://github.com/ABD-01/furo50/actions/workflows/docs.yml/badge.svg)](https://github.com/ABD-01/furo50/actions/workflows/docs.yml) -->

<!-- [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) -->


<!-- index.md content start -->

## Prerequisites

To use this extension you will need [Furo][furo link] theme for your project.

Install [furo][furo link]  theme and update html_theme in the [sphinx configuration][conf link]

## Usage

1. Install Furo50 extension in your sphinx environment.
    ```
    pip install furo50
    ```

2. In the [`conf.py`][conf link] configuration file, add [furo50][furo50 link] to the extensions list.
    ```
    extensions = [
        ...
        'furo50'
        ...
    ]
    ```
Your Sphinx documentation’s HTML pages will now be generated with this [CS50][cs50 link] theme! 🎉

## Features
* **CS50-Inspired Design**: Emulates the look and feel of [CS50][cs50 link]'s course pages.
* **Easy Configuration**: Simple configuration addition needed in conf.py for quick setup and customization.
* **Syntax Highlighting**: Incorporates CS50-style syntax highlighting for code blocks, improving code readability.
* **Sidebar Styles**: Offers both <span style="background-color:#a51c30;color:#fff;">crimson (CS50)</span> and <span  style="background-color:#000;color:#fff;">black (CS50X)</span> sidebar options, allowing users to choose their preferred aesthetic.
* **Seamless Furo Integration**: Built on top of the Furo theme, and is compatible with Furo's existing features and customizations.
* and more ...

<!-- index.md content end -->

## Changelog

Visit [furo50/changelog](https://abd-01.github.io/furo50/changelog/)

## Licence
Copyright © 2024, Muhammed Abdullah

This software is made available under the GPL v3.


<!-- Markdown links -->

[furo link]: https://pradyunsg.me/furo/
[furo50 link]: https://github.com/ABD-01/furo50
[cs50 link]: https://cs50.harvard.edu/college/2019/fall/
[conf link]: https://www.sphinx-doc.org/en/master/usage/configuration.html

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "furo50",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "documentation, sphinx, CS50",
    "author": null,
    "author_email": "ABD-01 <myac931@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/2e/b2/8a1138d7c336df6495b771b270ae1a2de5eb6fd563b9ad5ebcf1b8e01fbf/furo50-1.0.0a1.tar.gz",
    "platform": null,
    "description": "<h1 align=\"center\">Furo50</h1>\n<p align=\"center\">\n  A sphinx extenstion that turns <a href=\"https://github.com/pradyunsg/furo\">Furo theme</a> into <a href=\"https://cs50.harvard.edu/college/2019/fall/\">CS50</a>'s theme.\n</p>\n\n<p align=\"center\">\n    <a href=\"https://github.com/ABD-01/furo50/actions/workflows/tests.yml?branch=master\"><img src=\"https://github.com/ABD-01/furo50/actions/workflows/tests.yml/badge.svg?branch=master\" alt=\"Tests\"></a>\n    &emsp;\n    <a href=\"https://github.com/ABD-01/furo50/actions/workflows/docs.yml?branch=master\"><img src=\"https://github.com/ABD-01/furo50/actions/workflows/docs.yml/badge.svg?branch=master\" alt=\"Docs\"></a>\n    &emsp;\n    <img src=\"https://raw.githubusercontent.com/ABD-01/furo50/master/docs/_static/coverage.svg\" alt=\"Coverage\">\n    &emsp;\n    <a href=\"https://github.com/psf/black\"><img src=\"https://img.shields.io/badge/code%20style-black-000000.svg\" alt=\"Code style: black\"></a>\n    &emsp;\n    <a href=\"https://www.gnu.org/licenses/gpl-3.0\"><img src=\"https://img.shields.io/badge/License-GPLv3-blue.svg\" alt=\"License: GPL v3\"></a>\n</p>\n<p align=\"center\">\n    <a href=\"https://pypi.org/project/furo50/\"><img alt=\"PyPI - Version\" src=\"https://img.shields.io/pypi/v/furo50\"></a>\n    &emsp;\n    <a href=\"https://pypi.org/project/furo50/\"><img alt=\"PyPI - Pyversions\" src=\"https://img.shields.io/pypi/pyversions/furo50\"></a>\n</p>\n\n<!-- [![Tests](https://github.com/ABD-01/furo50/actions/workflows/tests.yml/badge.svg?branch=master)](https://github.com/ABD-01/furo50/actions/workflows/tests.yml) &emsp; ![](docs/_static/coverage.svg) &emsp; [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) -->\n\n<!-- [![Documentation](https://github.com/ABD-01/furo50/actions/workflows/docs.yml/badge.svg)](https://github.com/ABD-01/furo50/actions/workflows/docs.yml) -->\n\n<!-- [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) -->\n\n\n<!-- index.md content start -->\n\n## Prerequisites\n\nTo use this extension you will need [Furo][furo link] theme for your project.\n\nInstall [furo][furo link]  theme and update html_theme in the [sphinx configuration][conf link]\n\n## Usage\n\n1. Install Furo50 extension in your sphinx environment.\n    ```\n    pip install furo50\n    ```\n\n2. In the [`conf.py`][conf link] configuration file, add [furo50][furo50 link] to the extensions list.\n    ```\n    extensions = [\n        ...\n        'furo50'\n        ...\n    ]\n    ```\nYour Sphinx documentation\u2019s HTML pages will now be generated with this [CS50][cs50 link] theme! \ud83c\udf89\n\n## Features\n* **CS50-Inspired Design**: Emulates the look and feel of [CS50][cs50 link]'s course pages.\n* **Easy Configuration**: Simple configuration addition needed in conf.py for quick setup and customization.\n* **Syntax Highlighting**: Incorporates CS50-style syntax highlighting for code blocks, improving code readability.\n* **Sidebar Styles**: Offers both <span style=\"background-color:#a51c30;color:#fff;\">crimson (CS50)</span> and <span  style=\"background-color:#000;color:#fff;\">black (CS50X)</span> sidebar options, allowing users to choose their preferred aesthetic.\n* **Seamless Furo Integration**: Built on top of the Furo theme, and is compatible with Furo's existing features and customizations.\n* and more ...\n\n<!-- index.md content end -->\n\n## Changelog\n\nVisit [furo50/changelog](https://abd-01.github.io/furo50/changelog/)\n\n## Licence\nCopyright \u00a9 2024, Muhammed Abdullah\n\nThis software is made available under the GPL v3.\n\n\n<!-- Markdown links -->\n\n[furo link]: https://pradyunsg.me/furo/\n[furo50 link]: https://github.com/ABD-01/furo50\n[cs50 link]: https://cs50.harvard.edu/college/2019/fall/\n[conf link]: https://www.sphinx-doc.org/en/master/usage/configuration.html\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Sphinx Extension that turns furo theme into CS50's theme.",
    "version": "1.0.0a1",
    "project_urls": {
        "Homepage": "https://github.com/ABD-01/furo50"
    },
    "split_keywords": [
        "documentation",
        " sphinx",
        " cs50"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "15c2131343a1d2468f7034ea8aae509378bb3be158bf6974fdc973a0578d332d",
                "md5": "6d9426c58733edea73d8d8cf592fb0d6",
                "sha256": "f0407b0f07a526b6db69ba367104f3b308c94f20262a7a2c4960d3b3c3f39187"
            },
            "downloads": -1,
            "filename": "furo50-1.0.0a1-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6d9426c58733edea73d8d8cf592fb0d6",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 22125,
            "upload_time": "2024-08-28T15:44:34",
            "upload_time_iso_8601": "2024-08-28T15:44:34.047318Z",
            "url": "https://files.pythonhosted.org/packages/15/c2/131343a1d2468f7034ea8aae509378bb3be158bf6974fdc973a0578d332d/furo50-1.0.0a1-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2eb28a1138d7c336df6495b771b270ae1a2de5eb6fd563b9ad5ebcf1b8e01fbf",
                "md5": "12777ba08e75e86411422e35cec1ba4c",
                "sha256": "0b4ceae9f6a37d3a58d12398e429f9ade2dc8f266320f5a367a82b27e3d54edc"
            },
            "downloads": -1,
            "filename": "furo50-1.0.0a1.tar.gz",
            "has_sig": false,
            "md5_digest": "12777ba08e75e86411422e35cec1ba4c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 21500,
            "upload_time": "2024-08-28T15:44:36",
            "upload_time_iso_8601": "2024-08-28T15:44:36.621876Z",
            "url": "https://files.pythonhosted.org/packages/2e/b2/8a1138d7c336df6495b771b270ae1a2de5eb6fd563b9ad5ebcf1b8e01fbf/furo50-1.0.0a1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-28 15:44:36",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ABD-01",
    "github_project": "furo50",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "furo50"
}
        
Elapsed time: 0.30935s