{ "info": { "author": "Martin Bless", "author_email": "martin@mbless.de", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Framework :: Sphinx :: Extension", "Intended Audience :: End Users/Desktop", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Topic :: Documentation", "Topic :: Software Development :: Documentation" ], "description": "\n==============================\nA new theme for Docs.TYPO3.Org\n==============================\n\n:Project: t3SphinxThemeRtd\n:Team: TYPO3 Documentation Team\n:Author: Martin Bless \n:License: MIT\n:Demo: See this demo docs `t3SphinxThemeRtdDemoDocs\n `__\n which are kind of a \"stresstest\" and demonstrate what's possible and\n how the theme can be used.\n\nThis work builds on top of v0.1.8 of `https://github.com/snide/sphinx_rtd_theme\n`__.\n\nFind notes about the state of development `in this blogpost\n`__.\n\nNavigate this page:\n\n.. default-role:: code\n\n.. contents::\n :local:\n :depth: 3\n :backlinks: top\n\n\nInstallation\n============\n\nInstall the Theme Using PIP\n---------------------------\n\n`PIP `__ is the\n`Python `__ packet manager for\n`PyPi `__.\n't3SphinxThemeRtd' is provided by the TYPO3 Documentation Team\nand available from PyPi.\n\nInstallation with ``pip``::\n\n # fetch from PyPi and install latest version:\n pip install --upgrade t3SphinxThemeRtd\n\n # if required for your system, run a superuser:\n pip install --upgrade t3SphinxThemeRtd\n\nFor your interest: Some quick examples of ``pip`` usage::\n\n # find help\n pip install --help\n pip --help\n\n # install locally for this user only\n pip install --upgrade --user t3SphinxThemeRtd\n\n # uninstall - no matter if installed by PIP or setup.py:\n pip uninstall t3SphinxThemeRtd\n\n # search PyPi, the Python packet index\n pip search t3SphinxThemeRtd\n pip search sphinx\n\n\nInstall directly using 'setup.py'\n---------------------------------\n\nTo install directly from the package::\n\n git clone https://github.com/TYPO3-Documentation/t3SphinxThemeRtd.git\n cd t3SphinxThemeRtd\n (sudo) python setup.py install\n\n # or install locally in user's home:\n python setup.py --user install\n\n\nUsage\n=====\n\nIn the ``conf.py`` file of your documentation project:\n\nLoad the module::\n\n import t3SphinxThemeRtd\n\nChoose the theme::\n\n html_theme = \"t3SphinxThemeRtd\"\n\nSet the theme path::\n\n html_theme_path = [t3SphinxThemeRtd.get_html_theme_path()]\n\nOr, if that's better in your case, add the theme path to to the\nlist of already defined paths::\n\n html_theme_path = []\n # ...\n html_theme_path.append(t3SphinxThemeRtd.get_html_theme_path())\n\n\nSpecial Information for TYPO3 Users\n-----------------------------------\n\n1. Disable or remove any existing \"TYPO3 codeblock\"\n\n If the \"TYPO3 codeblock\" is part of your ``conf.py`` file\n then you need to remove or disable that code.\n You can do that easily by writing ``if 0`` instead of ``if 1``.\n\n .. figure:: Documentation/Images/disable-typo3-codeblock.png\n :alt: How to disable an existing TYPO3 codeblock in conf.py\n\n Disable any \"TYPO3 codeblock\" in your ``conf.py`` by\n writing ``if 0``.\n\n2. Once the \"TYPO3 codeblock\" is disabled the old `t3sphinx module\n `__\n IS NOT used any more. So you finally are being freed from old ballast\n and some of those old and annoying errors are gone. Rendering of Sphinx Json\n format will just work fine with the new theme.\n\n3. On the other hand: Since the ``t3sphinx module`` isn't loaded any more\n there is no processing of Yaml files for configuration at the moment. This\n means, at least for now:\n\n - You have to use a ``conf.py`` file for configuration.\n - You need to move all necessary settings from possible ``GlobalSettings.yml``\n and ``Settings.yml`` files into the ``conf.py``.\n\n4. Maybe we add Yaml processing in the future. At the moment this doesn't exist.\n\n5. **To quickly get going:** Feel free to copy from this\n `Typoscript Reference conf.py example file\n `__.\n The relevant parts are at the end.\n\n\nTo be done\n==========\n\nCheck this `list in the blogpost\n`__\n\n\nChangelog\n=========\n\nv3.1.0\n------\n- publish as 3.1.0\n- use minified jQuery\n- add our \"Edit me on GitHub\" button\n\nv3.0.0\n------\n\n- First public version.\n We start numbering this TYPO3 fork of the RTD theme with version number 3.0.0\n to be clearly different from the original ``sphinx_rtd_theme`` which is v0.1.8.\n\nAlready done\n------------\n\nCheck this `list in the blogpost\n`__\n\n\nHow the Table of Contents builds\n================================\n\nRead about this in the `original README `__.\n\n\nContributing or modifying the theme\n===================================\n\nThis chapter is taken from the `original README `__\n(and then modified)::\n\nThe ``t3SphinxThemeRtd`` is primarily a `Sass `__ project that\nrequires a few other Sass libraries. We are using `Bower `__ to\nmanage these dependencies and Sass to build the css. The good news is that there is\na nice set of `Grunt `__ operations that will not only load\nthese dependecies, but watch for changes, rebuild the sphinx demo docs and build\na distributable version of the theme. The bad news is this means you'll need to\nset up your environment similar to that of a front-end developer (versus that of\na python developer). That means installing `Node `__\nand `Ruby `__.\n\nSet up a development environment\n--------------------------------\n\n1. Install `Sphinx `__.\n It is a good idea - but not a requirement - to install into a `virtual environment\n `__::\n\n\n # Maybe activate virtualenv first. Then:\n\n pip install sphinx\n\n2. Install Sass::\n\n gem install sass\n\n3. Install Node, Bower and Grunt::\n\n # Install node\n brew install node\n\n # Install bower and grunt\n npm install -g bower grunt-cli\n\n # Now that everything is installed, let's install the theme's dependecies.\n cd t3SphinxThemeRtd\n npm install\n\n\n5. You may want to add the `Livereload Addons `__ to your\n Firefox and Chrome browser.\n\n6. Now that our environment is set up, make sure you're in your virtual environment, go to\n our package in the terminal and run Grunt::\n\n cd t3SphinxThemeRtd\n grunt\n\n Or, mabe even better, run Grunt in the background::\n\n cd t3SphinxThemeRtd\n grunt &\n\nThis default task will do the following **very cool things that make it worth the trouble**.\n\n1. It'll install and update any bower dependencies.\n2. It'll run sphinx and build the demo_docs.\n3. It'll watch for changes to the Sass files and build css from the changes.\n4. It'll rebuild the sphinx demo_docs anytime it notices a change to .rst, .html, .js\n or .css files.\n5. It'll start a local web server at localhost:1919.\n6. It'll show the demo_docs in the browser.\n7. It'll refresh the browser for localhost:1919 automatically if LiveReload is enabled.\n\nThere is a `grunt copy` command as well that copies files from the components\nthat bower fetches into the actual theme directory. For example fonts are move to the\nright place that way.\n\n**Note:** I you want that copy action you need to run ``grunt copy`` manually.\nIt is not run by default.\n\nEnd of README.\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/TYPO3-Documentation/t3SphinxThemeRtd", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "t3SphinxThemeRtd", "package_url": "https://pypi.org/project/t3SphinxThemeRtd/", "platform": "", "project_url": "https://pypi.org/project/t3SphinxThemeRtd/", "project_urls": { "Homepage": "https://github.com/TYPO3-Documentation/t3SphinxThemeRtd" }, "release_url": "https://pypi.org/project/t3SphinxThemeRtd/3.6.15/", "requires_dist": null, "requires_python": "", "summary": "Docs.TYPO3.Org theme for Sphinx, starting 2015.", "version": "3.6.15" }, "last_serial": 4030252, "releases": { "3.5.0": [ { "comment_text": "", "digests": { "md5": "dbc0458734263157695c2d006d045839", "sha256": "904c5015191909eabafebf6aeaad2ac424e9232c766a29bf5e5c3af194735c0d" }, "downloads": -1, "filename": "t3SphinxThemeRtd-3.5.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "dbc0458734263157695c2d006d045839", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 3431895, "upload_time": "2016-06-29T08:57:54", "url": "https://files.pythonhosted.org/packages/c7/e0/698884c284885ccff490893ac5f53a1ca4b505806466c6c73899152386e0/t3SphinxThemeRtd-3.5.0-py2.py3-none-any.whl" } ], "3.6": [ { "comment_text": "", "digests": { "md5": "de8a62ba18b2054696365af0aede20da", "sha256": "43427823b6f192cdfda894445c5d14ce9b8d9e940b419e69129a4a882421a69e" }, "downloads": -1, "filename": "t3SphinxThemeRtd-3.6-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "de8a62ba18b2054696365af0aede20da", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 3430200, "upload_time": "2016-06-30T08:13:46", "url": "https://files.pythonhosted.org/packages/0c/89/df744ef27620b8333e11c0ba29e425479388075005f0f9bf4b7100a566f4/t3SphinxThemeRtd-3.6-py2.py3-none-any.whl" } ], "3.6.1": [ { "comment_text": "", "digests": { "md5": "99033e4c7b8a3eae72c1e92be2da4645", "sha256": "4ffdc131458787192474ed51062767d0016ed182cbc24f2c54b853b5ef804672" }, "downloads": -1, "filename": "t3SphinxThemeRtd-3.6.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "99033e4c7b8a3eae72c1e92be2da4645", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 3432683, "upload_time": "2016-09-11T23:05:45", "url": "https://files.pythonhosted.org/packages/2e/99/e3a197a0e9063466ba70e81200d2015844a77f9853f120536b73340bc499/t3SphinxThemeRtd-3.6.1-py2.py3-none-any.whl" } ], "3.6.10": [ { "comment_text": "", "digests": { "md5": "881bdd58425d7eea9ae9c84bcb09950b", "sha256": "79da4fe615bb47d93cbfa01039652c0e89aa5fcedc1521dcc509d1b60ec1d7a1" }, "downloads": -1, "filename": "t3SphinxThemeRtd-3.6.10-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "881bdd58425d7eea9ae9c84bcb09950b", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 3418371, "upload_time": "2017-07-18T16:41:57", "url": "https://files.pythonhosted.org/packages/50/c8/7929ee7a624f22eb793ee1b3bb937730de5e7f688018808be5f374949fae/t3SphinxThemeRtd-3.6.10-py2.py3-none-any.whl" } ], "3.6.11": [ { "comment_text": "", "digests": { "md5": "9cef32e2cbe8bd07c851c6342eb55963", "sha256": "09f324580e6586c682571329fabd49c0e6dda9caaff7c4c74924347f96b5aae4" }, "downloads": -1, "filename": "t3SphinxThemeRtd-3.6.11-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "9cef32e2cbe8bd07c851c6342eb55963", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 3418626, "upload_time": "2017-08-30T15:56:12", "url": "https://files.pythonhosted.org/packages/b2/00/6c57ab6ea1d8c406428403e848a6134b0de11fda2db925126a68c80d0ff4/t3SphinxThemeRtd-3.6.11-py2.py3-none-any.whl" } ], "3.6.12": [ { "comment_text": "", "digests": { "md5": "6b41b7f38d7d2f196f0e93d2c4ce7bae", "sha256": "bff9483a929d1d74b3f30c4a6f9f5d31145699fd9d2afea086b3ff0618ec423f" }, "downloads": -1, "filename": "t3SphinxThemeRtd-3.6.12-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "6b41b7f38d7d2f196f0e93d2c4ce7bae", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 3418865, "upload_time": "2017-08-31T09:11:32", "url": "https://files.pythonhosted.org/packages/7b/c7/8bc0e9bf08c69b6fb645dda1edf2d187e6b1be72c866050c0e4926e60c44/t3SphinxThemeRtd-3.6.12-py2.py3-none-any.whl" } ], "3.6.15": [ { "comment_text": "", "digests": { "md5": "73a369c659c8ce99dbd3f8cb3798ccf7", "sha256": "0d84fe942b5d0d0f3da4ea3c11d72ece60727be138f91f5b2728ceaf246a1382" }, "downloads": -1, "filename": "t3SphinxThemeRtd-3.6.15-py3-none-any.whl", "has_sig": false, "md5_digest": "73a369c659c8ce99dbd3f8cb3798ccf7", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 3454958, "upload_time": "2018-07-04T14:11:59", "url": "https://files.pythonhosted.org/packages/ba/85/546510e970d7d10aa7eabc62b09d5e53c88739043fb80740077f814ab87b/t3SphinxThemeRtd-3.6.15-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "445d9d8b71ff99253ae8277452d7c671", "sha256": "2aff8c8e032b39caccd7aa19663684f353dda8ac646960f65031f4c549fe4004" }, "downloads": -1, "filename": "t3SphinxThemeRtd-3.6.15.tar.gz", "has_sig": false, "md5_digest": "445d9d8b71ff99253ae8277452d7c671", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3425300, "upload_time": "2018-07-04T14:12:23", "url": "https://files.pythonhosted.org/packages/2c/11/6dbe65f9494e2eacdacd402d4e1bca2fcd2e7f63b658cb590cde10798579/t3SphinxThemeRtd-3.6.15.tar.gz" } ], "3.6.3": [ { "comment_text": "", "digests": { "md5": "3972646c382b49bed8712605f103b1e3", "sha256": "85b1eac2025cdf9d5a729076f25646f46bc63820d0f113d2c58bce5952dacb2d" }, "downloads": -1, "filename": "t3SphinxThemeRtd-3.6.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "3972646c382b49bed8712605f103b1e3", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 3433944, "upload_time": "2016-09-14T09:55:50", "url": "https://files.pythonhosted.org/packages/85/9e/c956a3bc551cb0d3904328b9d12b8277317924289b6976daa384f024a533/t3SphinxThemeRtd-3.6.3-py2.py3-none-any.whl" } ], "3.6.4": [ { "comment_text": "", "digests": { "md5": "270c35a75f1261bafc12f1bf40d69536", "sha256": "5a4f930f41290aa05bc14cd90357c4dc17a0ade807342ab4d7adeedffd8b4f9a" }, "downloads": -1, "filename": "t3SphinxThemeRtd-3.6.4-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "270c35a75f1261bafc12f1bf40d69536", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 3416063, "upload_time": "2016-09-14T19:55:36", "url": "https://files.pythonhosted.org/packages/e3/1b/d938123f2b9059717707ba3427b64ade8d887c45588ac4aaa905731f0b81/t3SphinxThemeRtd-3.6.4-py2.py3-none-any.whl" } ], "3.6.6": [ { "comment_text": "", "digests": { "md5": "0807602de6fbbc4e7dca759e0a90bc98", "sha256": "3c8f78d0ef510f22d7a068d9e01fcf13a23a7445a1bb377c241fe74ff23f86d8" }, "downloads": -1, "filename": "t3SphinxThemeRtd-3.6.6-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "0807602de6fbbc4e7dca759e0a90bc98", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 3416192, "upload_time": "2017-03-15T10:48:56", "url": "https://files.pythonhosted.org/packages/08/12/857b55136fe24e701328dca55e3b870b8da1504ace7f3b95ab9d15d8f7e3/t3SphinxThemeRtd-3.6.6-py2.py3-none-any.whl" } ], "3.6.7": [ { "comment_text": "", "digests": { "md5": "a69ac2b826dbe64d4a9e7ef52881271e", "sha256": "a40953ee99ecb885d61c6f5dbd3341a52f19c16ecedbf7f691b69979528bbacd" }, "downloads": -1, "filename": "t3SphinxThemeRtd-3.6.7-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a69ac2b826dbe64d4a9e7ef52881271e", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 3416381, "upload_time": "2017-03-15T11:02:42", "url": "https://files.pythonhosted.org/packages/a2/a0/deaa9164e9e4176daf3a4dce203d9485ac7eb24792465e68bc40db2a7db9/t3SphinxThemeRtd-3.6.7-py2.py3-none-any.whl" } ], "3.6.8": [ { "comment_text": "", "digests": { "md5": "b414ad9d68e2e5077cd5b6f23bf49846", "sha256": "5321d7d7dab33abac2c76e491225d5092f709480dc0936e7bdb57f7068ce7e65" }, "downloads": -1, "filename": "t3SphinxThemeRtd-3.6.8-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "b414ad9d68e2e5077cd5b6f23bf49846", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 3417852, "upload_time": "2017-04-03T09:09:56", "url": "https://files.pythonhosted.org/packages/5b/ba/fb2919c464f90f7ac03ef0f573b358dca0d3b807c323416748624895745f/t3SphinxThemeRtd-3.6.8-py2.py3-none-any.whl" } ], "3.6.9": [ { "comment_text": "", "digests": { "md5": "6ba31b9250d67dbc2e7f04ce8826d121", "sha256": "d4beee6b80126516f4316601cef0d50e2d90b878fe2ad4d292ffc0b51c2bae4b" }, "downloads": -1, "filename": "t3SphinxThemeRtd-3.6.9-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "6ba31b9250d67dbc2e7f04ce8826d121", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 3418158, "upload_time": "2017-07-10T20:10:46", "url": "https://files.pythonhosted.org/packages/86/ab/975328e5531387ee29dec6e00a57bb226231a2806527caed3b09c8233521/t3SphinxThemeRtd-3.6.9-py2.py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "73a369c659c8ce99dbd3f8cb3798ccf7", "sha256": "0d84fe942b5d0d0f3da4ea3c11d72ece60727be138f91f5b2728ceaf246a1382" }, "downloads": -1, "filename": "t3SphinxThemeRtd-3.6.15-py3-none-any.whl", "has_sig": false, "md5_digest": "73a369c659c8ce99dbd3f8cb3798ccf7", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 3454958, "upload_time": "2018-07-04T14:11:59", "url": "https://files.pythonhosted.org/packages/ba/85/546510e970d7d10aa7eabc62b09d5e53c88739043fb80740077f814ab87b/t3SphinxThemeRtd-3.6.15-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "445d9d8b71ff99253ae8277452d7c671", "sha256": "2aff8c8e032b39caccd7aa19663684f353dda8ac646960f65031f4c549fe4004" }, "downloads": -1, "filename": "t3SphinxThemeRtd-3.6.15.tar.gz", "has_sig": false, "md5_digest": "445d9d8b71ff99253ae8277452d7c671", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3425300, "upload_time": "2018-07-04T14:12:23", "url": "https://files.pythonhosted.org/packages/2c/11/6dbe65f9494e2eacdacd402d4e1bca2fcd2e7f63b658cb590cde10798579/t3SphinxThemeRtd-3.6.15.tar.gz" } ] }