{ "info": { "author": "", "author_email": "", "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": ".. _readthedocs.org: http://www.readthedocs.org\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\n**************************\nRead the Docs Sphinx Theme\n**************************\n\nView a working demo_ over on readthedocs.org_.\n\nThis is a prototype mobile-friendly sphinx_ theme I made for readthedocs.org_. It's\ncurrently in development and includes some rtd variable checks that can be ignored\nif you're just trying to use it on your project outside of that site.\n\n.. image:: screen_mobile.png\n :width: 100%\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 sphinx_rtd_theme\n\nIn your ``conf.py`` file:\n\n.. code:: python\n\n import sphinx_rtd_theme\n\n html_theme = \"sphinx_rtd_theme\"\n\n html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]\n\nVia git or download\n-------------------\n\nSymlink or subtree the ``sphinx_rtd_theme/sphinx_rtd_theme`` repository into your documentation at\n``docs/_themes/sphinx_rtd_theme`` then add the following two settings to your Sphinx\nconf.py file:\n\n.. code:: python\n\n html_theme = \"sphinx_rtd_theme\"\n html_theme_path = [\"_themes\", ]\n\nHow the Table of Contents builds\n================================\n\nCurrently the left menu will build based upon any ``toctree(s)`` defined in your index.rst file.\nIt outputs 2 levels of depth, which should give your visitors a high level of access to your\ndocs. If no toctrees are set the theme reverts to sphinx's usual local toctree.\n\nIt's important to note that if you don't follow the same styling for your rST headers across\nyour documents, the toctree will misbuild, and the resulting menu might not show the correct\ndepth when it renders.\n\nContributing or modifying the theme\n===================================\n\nThe sphinx_rtd_theme is primarily a sass_ project that requires a few other sass libraries. I'm\nusing bower_ to manage these dependencies and compass_ to build the css. The good news is\nI have a very nice set of grunt_ operations that will not only load these dependecies, 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 pip install sphinx\n\n2. Install sass and compass\n\n.. code::\n\n gem install sass compass\n\n2. Install node, bower and grunt.\n\n.. code::\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 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.\n\nBefore you send a Pull Request\n------------------------------\n\nWhen you're done with your edits, you can run ``grunt build`` to clean out the old\nfiles and rebuild a new distribution, compressing the css and cleaning out\nextraneous files. Please do this before you send in a PR.\n\nTODO\n====\n* Build real demo docs with lots of rst examples\n* Update to font-awesome 4.0 and have it build from bower, not the copy/paste hack I have now.\n* Separate some sass variables at the theme level so you can overwrite some basic colors.\n* Add the ability to set a logo.", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "sphinx-pynpoint-theme", "package_url": "https://pypi.org/project/sphinx-pynpoint-theme/", "platform": "", "project_url": "https://pypi.org/project/sphinx-pynpoint-theme/", "project_urls": null, "release_url": "https://pypi.org/project/sphinx-pynpoint-theme/0.1.7/", "requires_dist": null, "requires_python": "", "summary": "ETH cosmology theme for Sphinx, 2013 version.", "version": "0.1.7" }, "last_serial": 5944375, "releases": { "0.1.6": [ { "comment_text": "", "digests": { "md5": "eaa6cde34e5cce084e44d6b9fadb7669", "sha256": "5d691151f3dcaede0173fa70f3c821e0182abd620f49bad9b64c4a48357490b6" }, "downloads": -1, "filename": "sphinx-pynpoint-theme-0.1.6.tar.gz", "has_sig": false, "md5_digest": "eaa6cde34e5cce084e44d6b9fadb7669", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 226592, "upload_time": "2018-06-19T13:49:26", "url": "https://files.pythonhosted.org/packages/9f/d5/bcb5df422ae06afee0df6ae1a8af0f5efd2880ce85cbb16681268b113abc/sphinx-pynpoint-theme-0.1.6.tar.gz" } ], "0.1.7": [ { "comment_text": "", "digests": { "md5": "e5ff5ca39f949920a3e197a03fb7ea21", "sha256": "60928302038cba317cac1d8fb6ee7487ffb48aa7bed46102da96d105e5a6ecd9" }, "downloads": -1, "filename": "sphinx-pynpoint-theme-0.1.7.tar.gz", "has_sig": false, "md5_digest": "e5ff5ca39f949920a3e197a03fb7ea21", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 226620, "upload_time": "2019-10-08T11:38:24", "url": "https://files.pythonhosted.org/packages/61/34/492c6e3ca367ed8fd8f97fb8e9012b8897908a978a5001eb5e3db5f167ba/sphinx-pynpoint-theme-0.1.7.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "e5ff5ca39f949920a3e197a03fb7ea21", "sha256": "60928302038cba317cac1d8fb6ee7487ffb48aa7bed46102da96d105e5a6ecd9" }, "downloads": -1, "filename": "sphinx-pynpoint-theme-0.1.7.tar.gz", "has_sig": false, "md5_digest": "e5ff5ca39f949920a3e197a03fb7ea21", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 226620, "upload_time": "2019-10-08T11:38:24", "url": "https://files.pythonhosted.org/packages/61/34/492c6e3ca367ed8fd8f97fb8e9012b8897908a978a5001eb5e3db5f167ba/sphinx-pynpoint-theme-0.1.7.tar.gz" } ] }