{ "info": { "author": "Association of Universities for Research in Astronomy", "author_email": "jsick@lsst.org", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Framework :: Sphinx :: Theme", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3" ], "description": "###########################\nlsst-sphinx-bootstrap-theme\n###########################\n\n.. image:: https://img.shields.io/travis/lsst-sqre/lsst-sphinx-bootstrap-theme.svg\n :alt: Travis build status\n\nThis is a prototype Sphinx theme for LSST Stack documentation, based on the Astropy Sphinx theme.\n\nGetting started with development\n================================\n\nGet the repo::\n\n git clone https://github.com/lsst-sqre/lsst-sphinx-bootstrap-theme\n cd lsst-sphinx-bootstrap-theme\n\nInstall JavaScript dependencies::\n\n npm install -g gulp-cli\n npm install\n\nCompile the assets and continue watching for changes::\n\n gulp\n\n.. _codebase:\n\nCodebase orientation\n====================\n\n- ``lsst_sphinx_bootstrap_theme/`` is the theme's Python package\n\n - ``static/`` is for static assets deployed onto the site. ``app.css`` is generated with ``gulp``, so don't edit it directly.\n\n - ``layout.html`` is the main Jinja2 template for the HTML. The other HTML files are blocks/partials.\n\n- ``scss/`` contains Sass source files that get compiled into ``lsst_sphinx_bootstrap_theme/static/app.css``.\n\n.. _gulp-commands:\n\nGulp commands\n=============\n\nThis project uses Gulp_ to run its build pipelines.\nThis section describes the gulp commands you can run.\n\ngulp\n----\n\nUse this default command for development.\nIt does the following:\n\n- `sass <#gulp-scss>`__ (compile Sass)\n- Watches for changes and recompiles assets as necessary.\n\n.. _gulp-scss:\n\ngulp scss\n---------\n\nCompile Sass into CSS (``app.css``).\nWe use the following features:\n\n- Compile Sass.\n- Add prefixes to CSS using Autoprefixer_ (via PostCSS_).\n- Clean and compress the CSS using gulp-clean-css.\n\nYou can run this task alone, but usually through ``gulp`` (default task).\n\n.. _gulp-pretty:\n\ngulp pretty\n-----------\n\nAutomatically format code.\nSee `Code style via Prettier <#code-style>`__.\n\n.. _code-style:\n\nCode style via Prettier\n=======================\n\nThis project uses Prettier_ to make sure the Sass and JavaScript are formatted as you'd expect.\nLike most projects, we use Prettier_ nearly as-is.\nA couple minor exceptions are configured in ``.prettierrc.yaml``.\n\nYou can run Prettier_ two ways:\n\n1. Manually, by running `gulp pretty `__.\n2. Automatically, by committing code.\n This is configured as a pre-commit hook in ``package.json``.\n\nNote that `Prettier's`_ pre-commit hook and chunked git commits don't mix.\nYou'll want to manually run Prettier_ before committing a subset of the changed lines in your files.\n\n.. _release-process:\n\nRelease process\n===============\n\n1. Update the change log (``CHANGELOG.rst``), commit, and marge work to ``master``.\n\n2. Tag the release using a `PEP 440`_\\ -compatible version string::\n\n git tag -s X.Y.Z -m \"X.Y.Z\"\n\n Push the tag::\n\n git tags --push\n\nThe Travis CI pipeline will create and upload the release to PyPI.\n\n.. _`Prettier's`:\n.. _Prettier: https://prettier.io\n.. _Gulp: https://gulpjs.com\n.. _Webpack: https://webpack.js.org\n.. _Autoprefixer: https://github.com/postcss/autoprefixer/\n.. _PostCSS: https://postcss.org\n.. _gulp-clean-css: https://www.npmjs.com/package/gulp-clean-css\n.. _PEP 440: https://www.python.org/dev/peps/pep-0440/", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/lsst-sqre/lsst-sphinx-bootstrap-theme", "keywords": "", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "lsst-sphinx-bootstrap-theme", "package_url": "https://pypi.org/project/lsst-sphinx-bootstrap-theme/", "platform": "", "project_url": "https://pypi.org/project/lsst-sphinx-bootstrap-theme/", "project_urls": { "Homepage": "https://github.com/lsst-sqre/lsst-sphinx-bootstrap-theme" }, "release_url": "https://pypi.org/project/lsst-sphinx-bootstrap-theme/0.2.1/", "requires_dist": null, "requires_python": "", "summary": "Sphinx theme for LSST user documentation built on Bootstrap and Astropy's theme.", "version": "0.2.1" }, "last_serial": 5620351, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "b77c25a729dbffbf75b49b84dcf6bdc4", "sha256": "313599c74510ae35289840a26c46b255e61e8abdb05fd4d7598904aee33ba0c4" }, "downloads": -1, "filename": "lsst_sphinx_bootstrap_theme-0.1.0-py2-none-any.whl", "has_sig": false, "md5_digest": "b77c25a729dbffbf75b49b84dcf6bdc4", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 20912, "upload_time": "2016-12-14T20:32:56", "url": "https://files.pythonhosted.org/packages/14/fe/45d2240250c5f8918980bb6615090e3704c74578d88a1a4e00554e39d417/lsst_sphinx_bootstrap_theme-0.1.0-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ed40057e14457af430ce0cfd5376a341", "sha256": "40c2724cfbbd12894c4df4144d5a915dee968218b47a9e4a29cc535fd2458352" }, "downloads": -1, "filename": "lsst-sphinx-bootstrap-theme-0.1.0.tar.gz", "has_sig": false, "md5_digest": "ed40057e14457af430ce0cfd5376a341", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 19333, "upload_time": "2016-12-14T20:32:59", "url": "https://files.pythonhosted.org/packages/71/44/ea5f2f3fc5c7efd4662f961dddccf9151c1ca5b0fae35283a4e2739c38a7/lsst-sphinx-bootstrap-theme-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "57af86fb999428f5ef052d62e2d5b02d", "sha256": "1b052292c26d7af073f11556870597a2731d3479b198489e4d72ba3537a0df62" }, "downloads": -1, "filename": "lsst-sphinx-bootstrap-theme-0.1.1.tar.gz", "has_sig": false, "md5_digest": "57af86fb999428f5ef052d62e2d5b02d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 19565, "upload_time": "2017-01-25T04:59:27", "url": "https://files.pythonhosted.org/packages/ef/67/a86e7ad474a89b5a2a1339b6881598893444d6fc73ab4d83ccb12111b170/lsst-sphinx-bootstrap-theme-0.1.1.tar.gz" } ], "0.1.1rc1": [ { "comment_text": "", "digests": { "md5": "2a26cf9b6f104e8ea89bb73418640729", "sha256": "2e2474bccdefb0937d691dcd59b0e8f5c1b1b6e609a2a59c371b8f939db7c76f" }, "downloads": -1, "filename": "lsst-sphinx-bootstrap-theme-0.1.1rc1.macosx-10.12-x86_64.tar.gz", "has_sig": false, "md5_digest": "2a26cf9b6f104e8ea89bb73418640729", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17755, "upload_time": "2017-01-24T19:48:21", "url": "https://files.pythonhosted.org/packages/3c/68/9b49319299b0c83bc38687e1a5033d56fab8d630d636b50cc24c77840769/lsst-sphinx-bootstrap-theme-0.1.1rc1.macosx-10.12-x86_64.tar.gz" } ], "0.1.1rc2": [ { "comment_text": "", "digests": { "md5": "b9de4f6979ed59b71a7bbf24780d8fcd", "sha256": "7d7758eabb2421a54a5a857bbbf7eee51cd824bef53512b65a593698d464a651" }, "downloads": -1, "filename": "lsst-sphinx-bootstrap-theme-0.1.1rc2.tar.gz", "has_sig": false, "md5_digest": "b9de4f6979ed59b71a7bbf24780d8fcd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 19408, "upload_time": "2017-01-24T19:52:16", "url": "https://files.pythonhosted.org/packages/82/8c/e93eec86eeff9c97fb431fd49a378295043dbde35b1f172731e53f457b4f/lsst-sphinx-bootstrap-theme-0.1.1rc2.tar.gz" } ], "0.1.1rc4": [ { "comment_text": "", "digests": { "md5": "76ac24bc9af374686812b5f685752b4f", "sha256": "a0e827c6543bc3e708837e9490a31dfab627193024b93bec385db72578be55f3" }, "downloads": -1, "filename": "lsst-sphinx-bootstrap-theme-0.1.1rc4.tar.gz", "has_sig": false, "md5_digest": "76ac24bc9af374686812b5f685752b4f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 19577, "upload_time": "2017-01-25T03:39:57", "url": "https://files.pythonhosted.org/packages/dc/98/affebad0e7808d83364bbb4b8e6caa0cdc65f6b45b43d16da828f8fec0da/lsst-sphinx-bootstrap-theme-0.1.1rc4.tar.gz" } ], "0.1.1rc5": [ { "comment_text": "", "digests": { "md5": "f9721ad6305b668dc424991e27a28383", "sha256": "c9437e6c0743bb2d51f6729132867116c9731bd904cba7c03c983f792ff2af36" }, "downloads": -1, "filename": "lsst-sphinx-bootstrap-theme-0.1.1rc5.tar.gz", "has_sig": false, "md5_digest": "f9721ad6305b668dc424991e27a28383", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 19576, "upload_time": "2017-01-25T03:49:17", "url": "https://files.pythonhosted.org/packages/3f/dc/ee73f094a553657d1a1f6a26cd6fd19d54e9bcd6aff7523f4e3e3a24bf16/lsst-sphinx-bootstrap-theme-0.1.1rc5.tar.gz" } ], "0.1.1rc6": [ { "comment_text": "", "digests": { "md5": "8ee6c80db3b7d4dbf0e41470acf204ff", "sha256": "482f2bd57e1c0ea7b738b4bb12f2d0e09d9958baef3a0c036f26553696d507fa" }, "downloads": -1, "filename": "lsst-sphinx-bootstrap-theme-0.1.1rc6.tar.gz", "has_sig": false, "md5_digest": "8ee6c80db3b7d4dbf0e41470acf204ff", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 19576, "upload_time": "2017-01-25T03:57:43", "url": "https://files.pythonhosted.org/packages/0b/9e/01673557fe433ad9784cb0f80980d0646a182bf1cc01d3d9180b851b4158/lsst-sphinx-bootstrap-theme-0.1.1rc6.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "d22628f88e00ced95802273b7d11dd6d", "sha256": "19670776697aef6af890b321636f826e95dee0413b64039a75df6901d362be9a" }, "downloads": -1, "filename": "lsst-sphinx-bootstrap-theme-0.1.2.tar.gz", "has_sig": false, "md5_digest": "d22628f88e00ced95802273b7d11dd6d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 19646, "upload_time": "2018-03-08T16:12:18", "url": "https://files.pythonhosted.org/packages/6e/e9/f0ef39d75ff06132b0f29ac9fd286dda1cc17c8bff04b2e40a3434b27fd4/lsst-sphinx-bootstrap-theme-0.1.2.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "91d9e5f58e2a33d7837c5de0d1fd19f7", "sha256": "54f7996cd08f7c57d5db5e2927e8f32204edf427e62e29de16c46fde3afbd05b" }, "downloads": -1, "filename": "lsst-sphinx-bootstrap-theme-0.2.0.tar.gz", "has_sig": false, "md5_digest": "91d9e5f58e2a33d7837c5de0d1fd19f7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 75352, "upload_time": "2018-05-24T00:36:57", "url": "https://files.pythonhosted.org/packages/ce/5c/768b9f26314e45122d3869635419caf221834a6d84c1f4e379949d9d2ee0/lsst-sphinx-bootstrap-theme-0.2.0.tar.gz" } ], "0.2.0rc1": [ { "comment_text": "", "digests": { "md5": "e6a1df8c2d15b1eac0570f4e9038a313", "sha256": "a3156a71f267fdb1d5960d87cef87f3b27c14342b660e502458043b06abe246a" }, "downloads": -1, "filename": "lsst-sphinx-bootstrap-theme-0.2.0rc1.tar.gz", "has_sig": false, "md5_digest": "e6a1df8c2d15b1eac0570f4e9038a313", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17413, "upload_time": "2018-05-20T22:29:40", "url": "https://files.pythonhosted.org/packages/47/9b/d2da180edaed5ebff1382f8c0cf8bbe390ec5e704cc5b4c69052e0150c12/lsst-sphinx-bootstrap-theme-0.2.0rc1.tar.gz" } ], "0.2.0rc3": [ { "comment_text": "", "digests": { "md5": "833964b769b90bc4ebaa9c26dd7fa6aa", "sha256": "5f1dc943720210f6f70ab15c60bbef726ca6e3d82b0da97baef6d742f229af89" }, "downloads": -1, "filename": "lsst-sphinx-bootstrap-theme-0.2.0rc3.tar.gz", "has_sig": false, "md5_digest": "833964b769b90bc4ebaa9c26dd7fa6aa", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 70301, "upload_time": "2018-05-21T15:49:35", "url": "https://files.pythonhosted.org/packages/b5/a1/2da6dfcadac3caec4ae00efed8922456bbc0f8ad03e63d0254d123a72a32/lsst-sphinx-bootstrap-theme-0.2.0rc3.tar.gz" } ], "0.2.0rc4": [ { "comment_text": "", "digests": { "md5": "2a05b06ea24d90a94d0c67113e4d1e8c", "sha256": "54d4c78417f1bcb74bc830d57d7a9171f197471162195caacbe0bf07dad24b84" }, "downloads": -1, "filename": "lsst-sphinx-bootstrap-theme-0.2.0rc4.tar.gz", "has_sig": false, "md5_digest": "2a05b06ea24d90a94d0c67113e4d1e8c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 70423, "upload_time": "2018-05-22T00:18:20", "url": "https://files.pythonhosted.org/packages/7b/2f/8a871c645d6f9185a8fb73948fa831922e98b83a27492317ecd28366a23a/lsst-sphinx-bootstrap-theme-0.2.0rc4.tar.gz" } ], "0.2.0rc5": [ { "comment_text": "", "digests": { "md5": "1cc51b3242a6305c6199a3eecdaddb0d", "sha256": "5124fcb03811bcd6c4039d85b9868a5b6d34825af63189d7743ca931eef337ef" }, "downloads": -1, "filename": "lsst-sphinx-bootstrap-theme-0.2.0rc5.tar.gz", "has_sig": false, "md5_digest": "1cc51b3242a6305c6199a3eecdaddb0d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 70605, "upload_time": "2018-05-23T22:31:29", "url": "https://files.pythonhosted.org/packages/a7/2e/2e3c6d765073c458e022cef4fb396025eedb91477d87299bc8f524762b68/lsst-sphinx-bootstrap-theme-0.2.0rc5.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "a4ffba9b7e851411516d50f9c3e91742", "sha256": "fc172202e3ecd00fc8e8d1e16faf777d929b9a3d3191e4fb54f7dcb3decee14c" }, "downloads": -1, "filename": "lsst-sphinx-bootstrap-theme-0.2.1.tar.gz", "has_sig": false, "md5_digest": "a4ffba9b7e851411516d50f9c3e91742", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 75561, "upload_time": "2019-08-01T19:27:38", "url": "https://files.pythonhosted.org/packages/2d/a2/7165c497a4e5ceb383116542c5e9b57cda85c80612627d8ed63b6eda1859/lsst-sphinx-bootstrap-theme-0.2.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "a4ffba9b7e851411516d50f9c3e91742", "sha256": "fc172202e3ecd00fc8e8d1e16faf777d929b9a3d3191e4fb54f7dcb3decee14c" }, "downloads": -1, "filename": "lsst-sphinx-bootstrap-theme-0.2.1.tar.gz", "has_sig": false, "md5_digest": "a4ffba9b7e851411516d50f9c3e91742", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 75561, "upload_time": "2019-08-01T19:27:38", "url": "https://files.pythonhosted.org/packages/2d/a2/7165c497a4e5ceb383116542c5e9b57cda85c80612627d8ed63b6eda1859/lsst-sphinx-bootstrap-theme-0.2.1.tar.gz" } ] }