{ "info": { "author": "Roy Art", "author_email": "royart@me.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Environment :: Web Environment", "Intended Audience :: Developers", "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", "Operating System :: OS Independent", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Documentation", "Topic :: Software Development :: Documentation" ], "description": "# Sphinx-Doc theme for Crafter CMS\n\nThis repo contains the necessary assets to develop and deploy the python package that powers the Crafter CMS \nSphinx Docs theme.\n\nA Gulp-powered build helps local development without `make html` to view the every change, making it easier \nto work on the front end of the theme. This system as the following features:\n\n- Handlebars HTML templates with Panini\n- Sass compilation and prefixing\n- JavaScript module bundling with webpack\n- Built-in BrowserSync server\n- For production builds:\n - CSS compression\n - JavaScript compression\n - Image compression\n\n## Local Theme Development\n\n### Prerequisites\n\nTo use this, you need:\n\n- [NodeJS](https://nodejs.org/en/) (0.12 or greater)\n- [Git](https://git-scm.com/)\n- [Yarn](https://yarnpkg.com/en)\n- Python, twine and pip\n- Foundation cli: `yarn global add foundation-cli`\n- Run `yarn` to initialize the project (FYI. this is the equivalent to `npm install` in the yarn world)\n\n### Running the dev server\n\nRun `foundation watch`\n\n### Development\n\nThe above will start the dev server and watch for changes. The important files to get started and \nunderstanding are `src/layouts/default.html` and `src/pages/index.html`. These two are the markup \nthat renders what you see as soon as you run the watch. Index is what contains the test content to \nwork on styling.\n\nAt `src/assets/*` you'll find the other important parts ([s]css, js, imgs).\n\nAs for the sphinx theme itself, see `src/sphinx`.\n\n## Build\n\n- Run `yarn crafter`. This will update the `craftercms_sphinx_theme` directory which is the python\npackage to be built and published to PyPI\n- Run `python setup.py sdist` to create a \"source distribution\"\n - This will create `dist/` and inside with a .tar.gz\n- Run `python setup.py bdist_wheel --universal` to create a \"universal wheel\"\n - This will create a .whl inside of `dist/` and a `build/`\n- To upload project to PyPI \u2014 with twine:\n - [Set up your account](https://packaging.python.org/tutorials/distributing-packages/#uploading-your-project-to-pypi)\n - If you haven't already, `pip install twine` & `pip install wheel`\n - `twine upload dist/*`\n- Visit [PyPI](https://pypi.python.org/pypi?%3Aaction=pkg_edit&name=craftercms-sphinx-theme) to manage the package\n- Tada! Done.\n\n#### Extra credit\n\nhttps://packaging.python.org/tutorials/distributing-packages\n\n\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/craftercms/craftercms-sphinx-theme/", "keywords": "", "license": "GPL version 3", "maintainer": "", "maintainer_email": "", "name": "craftercms-sphinx-theme", "package_url": "https://pypi.org/project/craftercms-sphinx-theme/", "platform": "", "project_url": "https://pypi.org/project/craftercms-sphinx-theme/", "project_urls": { "Homepage": "https://github.com/craftercms/craftercms-sphinx-theme/" }, "release_url": "https://pypi.org/project/craftercms-sphinx-theme/1.1.4/", "requires_dist": null, "requires_python": "", "summary": "Crafter CMS Docs theme for Sphinx Doc", "version": "1.1.4" }, "last_serial": 3579713, "releases": { "1.1.0a1": [ { "comment_text": "", "digests": { "md5": "f96dbf6aed6cbe346f45445d15c7e3eb", "sha256": "855b169c08236dd790a8d4da4c089c582763216f9c43045d839c60dd2e689507" }, "downloads": -1, "filename": "craftercms_sphinx_theme-1.1.0a1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "f96dbf6aed6cbe346f45445d15c7e3eb", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 91580, "upload_time": "2017-08-28T03:16:57", "url": "https://files.pythonhosted.org/packages/df/17/be2cb23ccad13b57a21624fa973230d1437d04264c1eab421d1146efb594/craftercms_sphinx_theme-1.1.0a1-py2.py3-none-any.whl" } ], "1.1.1a1": [ { "comment_text": "", "digests": { "md5": "36e352f2f9661fc18a4967ed750d6957", "sha256": "4c0711536a19b02920e9dffa8aa3667956684fb5c39349ff48fd676710e25a64" }, "downloads": -1, "filename": "craftercms_sphinx_theme-1.1.1a1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "36e352f2f9661fc18a4967ed750d6957", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 91537, "upload_time": "2017-08-28T10:42:26", "url": "https://files.pythonhosted.org/packages/66/48/928e374d7463d74e0fa520e55d5f2b916391f2be94246481e704fe74ad5a/craftercms_sphinx_theme-1.1.1a1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4d45063b98ecd7f24e5f280c693b81c3", "sha256": "7b44104c184429ade2d7a55c8d18cc595b1e2e148f04bde3f857f4a6ff19dd91" }, "downloads": -1, "filename": "craftercms_sphinx_theme-1.1.1a1.tar.gz", "has_sig": false, "md5_digest": "4d45063b98ecd7f24e5f280c693b81c3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1908, "upload_time": "2017-08-28T10:42:28", "url": "https://files.pythonhosted.org/packages/b7/30/70b325cecfe0cebbb898a0b6e404a6e07f7348a04fb704c97a5a2285b725/craftercms_sphinx_theme-1.1.1a1.tar.gz" } ], "1.1.2a1": [ { "comment_text": "", "digests": { "md5": "72058792a72cd310f9f3689f573e4aeb", "sha256": "2343a947a52a2fc5eb47e041cfee08027e0c2251bf7869bbf5165af1aad5aca7" }, "downloads": -1, "filename": "craftercms_sphinx_theme-1.1.2a1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "72058792a72cd310f9f3689f573e4aeb", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 99318, "upload_time": "2017-08-28T20:24:55", "url": "https://files.pythonhosted.org/packages/33/c1/d6c0b015c4b86ab823687e3c2eae0a76e7c60a2e20dfd2ebc7129b8bfc4e/craftercms_sphinx_theme-1.1.2a1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d1ca7613729e4f72172e2dc6291d60ed", "sha256": "619ec50be7970e39286bb84efec490ef34831cda14cbdc254fc70ae21cbd72a0" }, "downloads": -1, "filename": "craftercms_sphinx_theme-1.1.2a1.tar.gz", "has_sig": false, "md5_digest": "d1ca7613729e4f72172e2dc6291d60ed", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1823, "upload_time": "2017-08-28T20:24:58", "url": "https://files.pythonhosted.org/packages/76/8c/ad18127717eb3b68caf7af95c0ee5239bf75b3542c26ff70a4c6fcb4dc77/craftercms_sphinx_theme-1.1.2a1.tar.gz" } ], "1.1.3a1": [ { "comment_text": "", "digests": { "md5": "87569cf8045d5f347b95dc19bfd798e6", "sha256": "e00fdb07efbada6612852cbf6be3a05ea0c5aa45758131d5a8ff3f93a14b8427" }, "downloads": -1, "filename": "craftercms_sphinx_theme-1.1.3a1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "87569cf8045d5f347b95dc19bfd798e6", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 99338, "upload_time": "2017-08-28T20:36:33", "url": "https://files.pythonhosted.org/packages/40/70/063f3115ecc2e0d0949c5d7ae93875e1ceefa2823ca76779ba32499cf47e/craftercms_sphinx_theme-1.1.3a1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "363ba728dc6ca38aecbbe73f58dfda40", "sha256": "9d0b250fe3cac8580992d6b348bd97d342f7db47221fb4a231684bbf6d7c7dcc" }, "downloads": -1, "filename": "craftercms_sphinx_theme-1.1.3a1.tar.gz", "has_sig": false, "md5_digest": "363ba728dc6ca38aecbbe73f58dfda40", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1825, "upload_time": "2017-08-28T20:36:35", "url": "https://files.pythonhosted.org/packages/25/a3/0277ad7248f903e34ed7429870f6d9e4a423a907d1727048ed4adf95d951/craftercms_sphinx_theme-1.1.3a1.tar.gz" } ], "1.1.4": [ { "comment_text": "", "digests": { "md5": "588f178cd7b90de0393a23568e62847e", "sha256": "a4197cc03d71e3c952ce9259df5525c34c37268f5cb6aa45ad068bb3cb95d7da" }, "downloads": -1, "filename": "craftercms_sphinx_theme-1.1.4-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "588f178cd7b90de0393a23568e62847e", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 101702, "upload_time": "2018-02-13T21:35:35", "url": "https://files.pythonhosted.org/packages/7a/65/32adf1c9a316795ecd5b0ea826b01d57f623c7d3b8cfc6c78ab0002028da/craftercms_sphinx_theme-1.1.4-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "27e48bc7cb8704efd4fc3255757bf18e", "sha256": "158fff1f077febfebe269f9aa83895925b6ee2a38541504534a956154525db8f" }, "downloads": -1, "filename": "craftercms_sphinx_theme-1.1.4.tar.gz", "has_sig": false, "md5_digest": "27e48bc7cb8704efd4fc3255757bf18e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2847, "upload_time": "2018-02-13T21:35:37", "url": "https://files.pythonhosted.org/packages/44/d6/eebd35a199c625f20aa92b4819156d512974075a40eb534adbe23ec43976/craftercms_sphinx_theme-1.1.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "588f178cd7b90de0393a23568e62847e", "sha256": "a4197cc03d71e3c952ce9259df5525c34c37268f5cb6aa45ad068bb3cb95d7da" }, "downloads": -1, "filename": "craftercms_sphinx_theme-1.1.4-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "588f178cd7b90de0393a23568e62847e", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 101702, "upload_time": "2018-02-13T21:35:35", "url": "https://files.pythonhosted.org/packages/7a/65/32adf1c9a316795ecd5b0ea826b01d57f623c7d3b8cfc6c78ab0002028da/craftercms_sphinx_theme-1.1.4-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "27e48bc7cb8704efd4fc3255757bf18e", "sha256": "158fff1f077febfebe269f9aa83895925b6ee2a38541504534a956154525db8f" }, "downloads": -1, "filename": "craftercms_sphinx_theme-1.1.4.tar.gz", "has_sig": false, "md5_digest": "27e48bc7cb8704efd4fc3255757bf18e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2847, "upload_time": "2018-02-13T21:35:37", "url": "https://files.pythonhosted.org/packages/44/d6/eebd35a199c625f20aa92b4819156d512974075a40eb534adbe23ec43976/craftercms_sphinx_theme-1.1.4.tar.gz" } ] }