{ "info": { "author": "Dave Snider, RealTimeCat", "author_email": "dave.snider@gmail.com, info@learning-tech.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Environment :: Console", "Environment :: Web Environment", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Topic :: Documentation", "Topic :: Software Development :: Documentation" ], "description": ".. _sphinx_rtd_theme: https://github.com/snide/sphinx_rtd_theme\n.. _syncing a fork: https://help.github.com/articles/syncing-a-fork/\n.. _bower: http://www.bower.io\n.. _sphinx: http://www.sphinx-doc.org\n.. _compass: http://www.compass-style.org\n.. _sass: http://www.sass-lang.com\n.. _wyrm: http://www.github.com/snide/wyrm/\n.. _grunt: http://www.gruntjs.com\n.. _node: http://www.nodejs.com\n.. _demo: http://docs.readthedocs.org\n.. _hidden: http://sphinx-doc.org/markup/toctree.html\n\n************************\nRealTimeCat Sphinx Theme\n************************\n\n.. contents::\n\nRealTimeCat Sphinx theme is a fork of the excellent sphinx_rtd_theme_. See the documentation there for general information.\n\nStay in sync\n============\n\nIn order to always stay in sync with the upstream sphinx_rtd_theme_, this repository contains two remotes: ``upstream`` and ``origin``.\nSee Github's `syncing a fork`_ article for more information.\n\n\nInstallation\n============\n\nVia package\n-----------\n\nDownload the package or add it to your ``requirements.txt`` file:\n\n.. code:: bash\n\n $ pip install rtcat_sphinx_theme\n\nIn your ``conf.py`` file:\n\n.. code:: python\n\n import rtcat_sphinx_theme\n\n html_theme = \"rtcat_sphinx_theme\"\n\n html_theme_path = [rtcat_sphinx_theme.get_html_theme_path()]\n\nVia git or download\n-------------------\n\nSymlink or submodule/subtree the ``RTCat/rtcat_sphinx_theme`` repository into your documentation at\n``docs/_themes/rtcat_sphinx_theme`` then add the following two settings to your Sphinx\nconf.py file:\n\n.. code:: python\n\n html_theme = \"rtcat_sphinx_theme\"\n html_theme_path = [\"_themes/rtcat_sphinx_theme\", ]\n\nEditing\n=======\n\nThe rtcat_sphinx_theme is primarily a sass_ project that requires a few other sass libraries. I'm\nusing bower_ to manage these dependencies and sass_ to build the css. The good news is\nI have a very nice set of grunt_ operations that will not only load these dependencies, but watch\nfor changes, rebuild the sphinx demo docs and build a distributable version of the theme.\nThe bad news is this means you'll need to set up your environment similar to that\nof a front-end developer (vs. that of a python developer). That means installing node and ruby.\n\nSet up your environment\n-----------------------\n\n1. Install sphinx_ into a virtual environment.\n\n.. code::\n\n virtualenv ve\n source ve/bin/activate\n pip install sphinx\n\n2. Install sass\n\n.. code::\n\n gem install sass\n\n2. Install node, bower and grunt.\n\n.. code::\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 dependecies.\n npm install\n\nNow that our environment is set up, make sure you're in your virtual environment, go to\nthis repository in your terminal and run grunt:\n\n.. code::\n\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 new docs.\n3. It'll watch for changes to the sass files and build css from the changes.\n4. It'll rebuild the sphinx docs anytime it notices a change to .rst, .html, .js\n or .css files.", "description_content_type": null, "docs_url": null, "download_url": null, "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/RTCat/rtcat_sphinx_theme.git", "keywords": null, "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "rtcat-sphinx-theme", "package_url": "https://pypi.org/project/rtcat-sphinx-theme/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/rtcat-sphinx-theme/", "project_urls": { "Homepage": "https://github.com/RTCat/rtcat_sphinx_theme.git" }, "release_url": "https://pypi.org/project/rtcat-sphinx-theme/0.1.1/", "requires_dist": null, "requires_python": null, "summary": "Sphinx theme for http://docs.shishimao.com/", "version": "0.1.1" }, "last_serial": 2335996, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "bd784fd00b4486ca355c1fadd4c0e651", "sha256": "a1fa5a03bb24158fe3531bc00f7f9890d07b643f2484dc3d9d79495374a1c6d9" }, "downloads": -1, "filename": "rtcat_sphinx_theme-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "bd784fd00b4486ca355c1fadd4c0e651", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 691639, "upload_time": "2016-09-02T06:53:26", "url": "https://files.pythonhosted.org/packages/6a/b0/1d092da327e0cd9d27214923002a28ca9bec49dfc3462253fe2e27409739/rtcat_sphinx_theme-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "72031e6291f8b9ebb9495c6a9efa2968", "sha256": "2d08e86c88ab9ff30bed2e7d734f3dc286adba1dcdb5ab2229b62123d69578ea" }, "downloads": -1, "filename": "rtcat_sphinx_theme-0.1.0.tar.gz", "has_sig": false, "md5_digest": "72031e6291f8b9ebb9495c6a9efa2968", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 695878, "upload_time": "2016-09-02T06:53:35", "url": "https://files.pythonhosted.org/packages/09/ed/aad610f96199f71da2875b4c64cee0940fea7dac65b055dad1c344768077/rtcat_sphinx_theme-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "a8674ec4002fc6d258430b86dcf82f23", "sha256": "a68c9a0521705b80fb8060d0f0df861492d7144ef9c239171baf903414bd9a4d" }, "downloads": -1, "filename": "rtcat_sphinx_theme-0.1.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a8674ec4002fc6d258430b86dcf82f23", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 692059, "upload_time": "2016-09-11T10:00:50", "url": "https://files.pythonhosted.org/packages/1b/23/ed98a4f7aaec6266551d3b39f1e4635fd735d95a3b7cf3e1bec5a6cce898/rtcat_sphinx_theme-0.1.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "fcf3e5a8b96b3002e0db9856ec636b7f", "sha256": "6916f0cb4d41989b722b76d531a9a2c2d136b3925e3ae7d11e415a4bb956ce3e" }, "downloads": -1, "filename": "rtcat_sphinx_theme-0.1.1.tar.gz", "has_sig": false, "md5_digest": "fcf3e5a8b96b3002e0db9856ec636b7f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 696318, "upload_time": "2016-09-11T10:01:06", "url": "https://files.pythonhosted.org/packages/3a/36/dae60b9fb626ccd561238756b44a155b6f99f3fe73bc8d6689087a1682ab/rtcat_sphinx_theme-0.1.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "a8674ec4002fc6d258430b86dcf82f23", "sha256": "a68c9a0521705b80fb8060d0f0df861492d7144ef9c239171baf903414bd9a4d" }, "downloads": -1, "filename": "rtcat_sphinx_theme-0.1.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a8674ec4002fc6d258430b86dcf82f23", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 692059, "upload_time": "2016-09-11T10:00:50", "url": "https://files.pythonhosted.org/packages/1b/23/ed98a4f7aaec6266551d3b39f1e4635fd735d95a3b7cf3e1bec5a6cce898/rtcat_sphinx_theme-0.1.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "fcf3e5a8b96b3002e0db9856ec636b7f", "sha256": "6916f0cb4d41989b722b76d531a9a2c2d136b3925e3ae7d11e415a4bb956ce3e" }, "downloads": -1, "filename": "rtcat_sphinx_theme-0.1.1.tar.gz", "has_sig": false, "md5_digest": "fcf3e5a8b96b3002e0db9856ec636b7f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 696318, "upload_time": "2016-09-11T10:01:06", "url": "https://files.pythonhosted.org/packages/3a/36/dae60b9fb626ccd561238756b44a155b6f99f3fe73bc8d6689087a1682ab/rtcat_sphinx_theme-0.1.1.tar.gz" } ] }