napari-sphinx-theme


Namenapari-sphinx-theme JSON
Version 0.6.0 PyPI version JSON
download
home_pageNone
SummaryBootstrap-based Sphinx theme from the napari community
upload_time2025-01-22 00:58:48
maintainerNone
docs_urlNone
authornapari team
requires_python>=3.7
licenseBSD 3-Clause License Copyright (c) 2018, pandas All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # napari-sphinx-theme

A Sphinx theme based on the awesome
[pydata-sphinx-theme](https://github.com/pydata/pydata-sphinx-theme) with the
look and feel of napari.

This is currently a work-in-progress, but since it extends the
pydata-sphinx-theme, all the existing configurations and affordances are already
available. Check out the
[PyData Docs](https://pydata-sphinx-theme.readthedocs.io/en/latest/) for more
info.

## Installing for development

After creating a virtual environment, install the theme in editable mode:

```bash
python -m pip install -e .
```

## Building a demo site

To build the demo site, run:

```bash
cd docs/
make html
```

## Using it to build the napari website

To build the napari website, install the theme as a dependency.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "napari-sphinx-theme",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": null,
    "author": "napari team",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/81/bf/55774d5c489c7e98ac7adf0d2e5c48de5615e606308b62e4cc439a2e544a/napari_sphinx_theme-0.6.0.tar.gz",
    "platform": null,
    "description": "# napari-sphinx-theme\n\nA Sphinx theme based on the awesome\n[pydata-sphinx-theme](https://github.com/pydata/pydata-sphinx-theme) with the\nlook and feel of napari.\n\nThis is currently a work-in-progress, but since it extends the\npydata-sphinx-theme, all the existing configurations and affordances are already\navailable. Check out the\n[PyData Docs](https://pydata-sphinx-theme.readthedocs.io/en/latest/) for more\ninfo.\n\n## Installing for development\n\nAfter creating a virtual environment, install the theme in editable mode:\n\n```bash\npython -m pip install -e .\n```\n\n## Building a demo site\n\nTo build the demo site, run:\n\n```bash\ncd docs/\nmake html\n```\n\n## Using it to build the napari website\n\nTo build the napari website, install the theme as a dependency.\n",
    "bugtrack_url": null,
    "license": "BSD 3-Clause License  Copyright (c) 2018, pandas All rights reserved.  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:  * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.  * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.  * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
    "summary": "Bootstrap-based Sphinx theme from the napari community",
    "version": "0.6.0",
    "project_urls": {
        "homepage": "https://napari.org/napari-sphinx-theme/",
        "repository": "https://github.com/napari/napari-sphinx-theme"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bb21bb6c15dbae924cb4eb4f0b953a4c6e0f11355e32c0d72f25def83fdb5795",
                "md5": "713e08a42f3b7d4597e9d93d88f56270",
                "sha256": "df00d43e19c63c2253a38b39108ad1951faac8bce8735872f0eb680ec4e00512"
            },
            "downloads": -1,
            "filename": "napari_sphinx_theme-0.6.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "713e08a42f3b7d4597e9d93d88f56270",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 26993,
            "upload_time": "2025-01-22T00:58:46",
            "upload_time_iso_8601": "2025-01-22T00:58:46.470126Z",
            "url": "https://files.pythonhosted.org/packages/bb/21/bb6c15dbae924cb4eb4f0b953a4c6e0f11355e32c0d72f25def83fdb5795/napari_sphinx_theme-0.6.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "81bf55774d5c489c7e98ac7adf0d2e5c48de5615e606308b62e4cc439a2e544a",
                "md5": "598c03c8c9f0c9462765ec4251edb499",
                "sha256": "343c5ffac1cf9c5929a1a9b161cf846b14d693a772ae74ae57c8d4d14c357651"
            },
            "downloads": -1,
            "filename": "napari_sphinx_theme-0.6.0.tar.gz",
            "has_sig": false,
            "md5_digest": "598c03c8c9f0c9462765ec4251edb499",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 33442,
            "upload_time": "2025-01-22T00:58:48",
            "upload_time_iso_8601": "2025-01-22T00:58:48.375912Z",
            "url": "https://files.pythonhosted.org/packages/81/bf/55774d5c489c7e98ac7adf0d2e5c48de5615e606308b62e4cc439a2e544a/napari_sphinx_theme-0.6.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-22 00:58:48",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "napari",
    "github_project": "napari-sphinx-theme",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "napari-sphinx-theme"
}
        
Elapsed time: 0.84115s