trojanzoo-sphinx-theme


Nametrojanzoo-sphinx-theme JSON
Version 1.0.3 PyPI version JSON
download
home_pagehttps://github.com/ain-soph/trojanzoo_sphinx_theme
SummaryTrojanZoo Sphinx Theme
upload_time2023-05-14 20:56:24
maintainer
docs_urlNone
authorRen Pang
requires_python>3
licenseGPL-3
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # TrojanZoo Sphinx Theme


![sphinx>=7.0](https://img.shields.io/badge/sphinx->=7.0-informational.svg)

[![demo](https://github.com/ain-soph/trojanzoo_sphinx_theme/workflows/demo/badge.svg)](https://ain-soph.github.io/trojanzoo_sphinx_theme/)
[![release](https://img.shields.io/github/v/release/ain-soph/trojanzoo_sphinx_theme)](https://github.com/ain-soph/trojanzoo_sphinx_theme/releases)
[![pypi](https://img.shields.io/pypi/v/trojanzoo_sphinx_theme)](https://pypi.org/project/trojanzoo_sphinx_theme/)

Sphinx theme for [TrojanZoo Docs](https://ain-soph.github.io/trojanzoo) based on the [Read the Docs Sphinx Theme](https://sphinx-rtd-theme.readthedocs.io/en/latest). Forked from [Pytorch Sphinx Theme](https://github.com/pytorch/pytorch_sphinx_theme) with commit `b4d0005` at 09/24/2021.

## Difference from pytorch_sphinx_theme
This work removes all pytorch-related things and support many customizations. It also removes all other unnecessary items to make it a pure doc template.  
See demos at:  
https://ain-soph.github.io/trojanzoo_sphinx_theme/  
https://ain-soph.github.io/alpsplot/  
https://ain-soph.github.io/trojanzoo/

## Local Development

Run python setup:

```
git clone https://github.com/ain-soph/trojanzoo_sphinx_theme
pip install -e trojanzoo_sphinx_theme
```

and install the dependencies using `pip install -r requirements.txt`

In the root directory install the `package.json`:

```
# node version 8.4.0
yarn install

```

If you have `npm` installed then run:

```
npm install
```

Run grunt to build the html site and enable live reloading of the demo app at `localhost:1919`:

```
grunt
```

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ain-soph/trojanzoo_sphinx_theme",
    "name": "trojanzoo-sphinx-theme",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">3",
    "maintainer_email": "",
    "keywords": "",
    "author": "Ren Pang",
    "author_email": "rbp5354@psu.edu",
    "download_url": "https://files.pythonhosted.org/packages/49/69/aa5b9ab2c9fa171b75c0d15866dcd633d5f0638c8fe83fc1696f8b9ad7ba/trojanzoo_sphinx_theme-1.0.3.tar.gz",
    "platform": null,
    "description": "# TrojanZoo Sphinx Theme\n\n\n![sphinx>=7.0](https://img.shields.io/badge/sphinx->=7.0-informational.svg)\n\n[![demo](https://github.com/ain-soph/trojanzoo_sphinx_theme/workflows/demo/badge.svg)](https://ain-soph.github.io/trojanzoo_sphinx_theme/)\n[![release](https://img.shields.io/github/v/release/ain-soph/trojanzoo_sphinx_theme)](https://github.com/ain-soph/trojanzoo_sphinx_theme/releases)\n[![pypi](https://img.shields.io/pypi/v/trojanzoo_sphinx_theme)](https://pypi.org/project/trojanzoo_sphinx_theme/)\n\nSphinx theme for [TrojanZoo Docs](https://ain-soph.github.io/trojanzoo) based on the [Read the Docs Sphinx Theme](https://sphinx-rtd-theme.readthedocs.io/en/latest). Forked from [Pytorch Sphinx Theme](https://github.com/pytorch/pytorch_sphinx_theme) with commit `b4d0005` at 09/24/2021.\n\n## Difference from pytorch_sphinx_theme\nThis work removes all pytorch-related things and support many customizations. It also removes all other unnecessary items to make it a pure doc template.  \nSee demos at:  \nhttps://ain-soph.github.io/trojanzoo_sphinx_theme/  \nhttps://ain-soph.github.io/alpsplot/  \nhttps://ain-soph.github.io/trojanzoo/\n\n## Local Development\n\nRun python setup:\n\n```\ngit clone https://github.com/ain-soph/trojanzoo_sphinx_theme\npip install -e trojanzoo_sphinx_theme\n```\n\nand install the dependencies using `pip install -r requirements.txt`\n\nIn the root directory install the `package.json`:\n\n```\n# node version 8.4.0\nyarn install\n\n```\n\nIf you have `npm` installed then run:\n\n```\nnpm install\n```\n\nRun grunt to build the html site and enable live reloading of the demo app at `localhost:1919`:\n\n```\ngrunt\n```\n",
    "bugtrack_url": null,
    "license": "GPL-3",
    "summary": "TrojanZoo Sphinx Theme",
    "version": "1.0.3",
    "project_urls": {
        "Homepage": "https://github.com/ain-soph/trojanzoo_sphinx_theme"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e37f7826b61f3e4a8fb79a13c8a235a4fdf4f388c8f33cfbcfe78d99318f9289",
                "md5": "8341e048c1c752a5be74fc0e32060b14",
                "sha256": "c90ba12e980f22c6e3e49bf47cb9d54146e5f8b2ac643d72a4484b861863ff9b"
            },
            "downloads": -1,
            "filename": "trojanzoo_sphinx_theme-1.0.3-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8341e048c1c752a5be74fc0e32060b14",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">3",
            "size": 1427603,
            "upload_time": "2023-05-14T20:56:22",
            "upload_time_iso_8601": "2023-05-14T20:56:22.053289Z",
            "url": "https://files.pythonhosted.org/packages/e3/7f/7826b61f3e4a8fb79a13c8a235a4fdf4f388c8f33cfbcfe78d99318f9289/trojanzoo_sphinx_theme-1.0.3-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4969aa5b9ab2c9fa171b75c0d15866dcd633d5f0638c8fe83fc1696f8b9ad7ba",
                "md5": "55204913d3daeeaa4cd8c37d0d0e89f5",
                "sha256": "97352fda37a937567fa64974bb3cd5b36277d8e208faab8ee339f70234a7b34a"
            },
            "downloads": -1,
            "filename": "trojanzoo_sphinx_theme-1.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "55204913d3daeeaa4cd8c37d0d0e89f5",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">3",
            "size": 1446287,
            "upload_time": "2023-05-14T20:56:24",
            "upload_time_iso_8601": "2023-05-14T20:56:24.304452Z",
            "url": "https://files.pythonhosted.org/packages/49/69/aa5b9ab2c9fa171b75c0d15866dcd633d5f0638c8fe83fc1696f8b9ad7ba/trojanzoo_sphinx_theme-1.0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-05-14 20:56:24",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ain-soph",
    "github_project": "trojanzoo_sphinx_theme",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "trojanzoo-sphinx-theme"
}
Ren Pang
Elapsed time: 0.08174s