astropy-sphinx-theme-1.1/ 0000755 0000770 0000024 00000000000 13460270354 015405 5 ustar tom staff 0000000 0000000 astropy-sphinx-theme-1.1/CHANGES.rst 0000644 0000770 0000024 00000000534 13460270241 017204 0 ustar tom staff 0000000 0000000 1.1 (2019-04-25) ---------------- - Added a theme option ``astropy_project_menubar`` which can be used to control whether to show extra project links in the top bar. [#4, #8] - Fixed compatibility with Sphinx 2.x. [#6] 1.0 (2018-01-26) ---------------- - Initial standalone version of the theme (formerly packaged as part of astropy-helpers) astropy-sphinx-theme-1.1/LICENSE.rst 0000644 0000770 0000024 00000002730 13460270310 017213 0 ustar tom staff 0000000 0000000 Copyright (c) 2014-2019, Astropy Developers All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the Astropy Team nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. astropy-sphinx-theme-1.1/MANIFEST.in 0000644 0000770 0000024 00000000323 13232161045 017132 0 ustar tom staff 0000000 0000000 include *.txt include *.rst include *.py include astropy_sphinx_theme/__init__.py # Non-python files. recursive-include astropy_sphinx_theme * # Extraneous files. global-exclude .DS_Store global-exclude *.pyc astropy-sphinx-theme-1.1/PKG-INFO 0000644 0000770 0000024 00000004065 13460270354 016507 0 ustar tom staff 0000000 0000000 Metadata-Version: 1.0 Name: astropy-sphinx-theme Version: 1.1 Summary: The sphinx theme for Astropy and affiliated packages. Home-page: https://github.com/astropy/astropy-sphinx-theme Author: The Astropy Developers Author-email: astropy.team@gmail.com License: UNKNOWN Description: Astropy Sphinx Theme(s) ----------------------- This is the repository for the default Astropy project documentation theme(s). To use this theme, simply install this package then add the following line to your documentation's ``conf.py`` file: .. code:: python html_theme = 'bootstrap-astropy' This requires Sphinx 1.6 or later to work properly. For older versions of Sphinx, you will need to do: .. code:: python import astropy_sphinx_theme html_theme_path = astropy_sphinx_theme.get_html_theme_path() html_theme = 'bootstrap-astropy' ``bootstrap-astropy`` is the only theme that is currently available, but the structure of the package allows more themes to be added in future if needed. Several options for the theme can be set in the ``conf.py`` file: .. code:: python html_theme_options = { 'logotext1': 'packagename', # white, semi-bold 'logotext2': '', # orange, light 'logotext3': ':docs', # white, light 'astropy_project_menubar': True } The ``logotext?`` options can be used to customize the top left logo, while the ``astropy_project_menubar`` option can be set to ``True`` for packages that are managed by the project itself (this will add links to find out more about the Astropy project, about the team, and so on). .. image:: https://circleci.com/gh/astropy/astropy-sphinx-theme/tree/master.svg?style=svg :target: https://circleci.com/gh/astropy/astropy-sphinx-theme/tree/master Platform: UNKNOWN astropy-sphinx-theme-1.1/README.rst 0000644 0000770 0000024 00000002670 13460270167 017103 0 ustar tom staff 0000000 0000000 Astropy Sphinx Theme(s) ----------------------- This is the repository for the default Astropy project documentation theme(s). To use this theme, simply install this package then add the following line to your documentation's ``conf.py`` file: .. code:: python html_theme = 'bootstrap-astropy' This requires Sphinx 1.6 or later to work properly. For older versions of Sphinx, you will need to do: .. code:: python import astropy_sphinx_theme html_theme_path = astropy_sphinx_theme.get_html_theme_path() html_theme = 'bootstrap-astropy' ``bootstrap-astropy`` is the only theme that is currently available, but the structure of the package allows more themes to be added in future if needed. Several options for the theme can be set in the ``conf.py`` file: .. code:: python html_theme_options = { 'logotext1': 'packagename', # white, semi-bold 'logotext2': '', # orange, light 'logotext3': ':docs', # white, light 'astropy_project_menubar': True } The ``logotext?`` options can be used to customize the top left logo, while the ``astropy_project_menubar`` option can be set to ``True`` for packages that are managed by the project itself (this will add links to find out more about the Astropy project, about the team, and so on). .. image:: https://circleci.com/gh/astropy/astropy-sphinx-theme/tree/master.svg?style=svg :target: https://circleci.com/gh/astropy/astropy-sphinx-theme/tree/master astropy-sphinx-theme-1.1/astropy_sphinx_theme/ 0000755 0000770 0000024 00000000000 13460270354 021661 5 ustar tom staff 0000000 0000000 astropy-sphinx-theme-1.1/astropy_sphinx_theme/__init__.py 0000644 0000770 0000024 00000000537 13460270275 024001 0 ustar tom staff 0000000 0000000 """ Astropy Sphinx Theme """ import os __version__ = "1.1" def get_html_theme_path(): """Return list of HTML theme paths.""" cur_dir = os.path.abspath(os.path.dirname(__file__)) return [cur_dir] def setup(app): app.add_html_theme('bootstrap-astropy', os.path.abspath(os.path.join(os.path.dirname(__file__), 'bootstrap-astropy'))) astropy-sphinx-theme-1.1/astropy_sphinx_theme/bootstrap-astropy/ 0000755 0000770 0000024 00000000000 13460270354 025375 5 ustar tom staff 0000000 0000000 astropy-sphinx-theme-1.1/astropy_sphinx_theme/bootstrap-astropy/globaltoc.html 0000644 0000770 0000024 00000000111 13230402334 030210 0 ustar tom staff 0000000 0000000