Metadata-Version: 2.1
Name: renku-sphinx-theme
Version: 0.2.2
Summary: A Sphinx theme for Renku documentation.
Home-page: https://github.com/SwissDataScienceCenter/renku-sphinx-theme
Author: Swiss Data Science Center (SDSC)
Author-email: contact@datascience.ch
License: Apache License 2.0
Description: ..
            Copyright 2017 Swiss Data Science Center (SDSC)
            A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
            Eidgenössische Technische Hochschule Zürich (ETHZ).
        
            Licensed under the Apache License, Version 2.0 (the "License");
            you may not use this file except in compliance with the License.
            You may obtain a copy of the License at
        
                http://www.apache.org/licenses/LICENSE-2.0
        
            Unless required by applicable law or agreed to in writing, software
            distributed under the License is distributed on an "AS IS" BASIS,
            WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
            See the License for the specific language governing permissions and
            limitations under the License.
        
        =================================
         Sphinx Theme for Renku Projects
        =================================
        
        .. image:: https://img.shields.io/travis/SwissDataScienceCenter/renku-sphinx-theme.svg
                :target: https://travis-ci.org/SwissDataScienceCenter/renku-sphinx-theme
        
        .. image:: https://img.shields.io/github/tag/SwissDataScienceCenter/renku-sphinx-theme.svg
                :target: https://github.com/SwissDataScienceCenter/renku-sphinx-theme/releases
        
        .. image:: https://img.shields.io/pypi/dm/renku-sphinx-theme.svg
                :target: https://pypi.python.org/pypi/renku-sphinx-theme
        
        .. image:: https://img.shields.io/github/license/SwissDataScienceCenter/renku-sphinx-theme.svg
                :target: https://github.com/SwissDataScienceCenter/renku-sphinx-theme/blob/master/LICENSE
        
        A Sphinx theme for Renku documentation based on RTD theme.
        
        Installation
        ------------
        
        1. Add ``renku-sphinx-theme`` to ``setup.py`` or ``requirements.txt`` used
           for building your documentation.
        2. Set ``html_theme`` to ``'renku'`` in ``docs/conf.py``.
        3. Configure at least ``description`` and ``github_repo`` in
           ``html_theme_options``.
        
        Enjoy your beautiful Renku documentation style.
        
        
        Style (css)
        -----------
        
        This repo contains a scss file that generates a css file.
        The css file shouldn't be manually modified since it's generated with the scss.
        Instructions to change and run the scss file are inside the scss file.
        
        The easy way of doing style changes in this repository is to go to the renku repo, add a temporary css (custom.css) 
        in the ``docs/conf.py`` file and follow this steps: 
        
        https://renku.readthedocs.io/en/latest/developer/contributing/documentation.html
        
        The reason for this is that renku docs is a better repository for testing changes.
        
        After doing the changes in the temporary css add this to custom.scss in this repository, build this into 
        a css file using the instructions and commit the css and scss files.
        
        
        Building
        --------
        
        To build docs after doing changes, and test things inside this repository
        
        1. From the base folder... ``pip install -r docs/requirements.txt``
        2. This should be done in case there where changes in fonts or new css files added ``pip install --editable .``
        3. There is no Makefile here but in order to do the "make html" action you should do 
        
            ``cd docs``
            ``sphinx-build -b html -d _build/doctrees . _build/html``
        
        Docs will be built into ``_build/html...`` open this files with chrome to see the changes.
        
        
        Releasing
        ---------
        
        After doing changes, a new release should be published in pypi under the sdsc-org account.
        
        To release a new version, change the version inside version.py, do step 1 and 2 of Building.
        Then do ``python3 -m twine upload dist/*`` and the new release will be published on pypi.
        
        
        ..
            Copyright 2017 Swiss Data Science Center (SDSC)
            A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
            Eidgenössische Technische Hochschule Zürich (ETHZ).
        
            Licensed under the Apache License, Version 2.0 (the "License");
            you may not use this file except in compliance with the License.
            You may obtain a copy of the License at
        
                http://www.apache.org/licenses/LICENSE-2.0
        
            Unless required by applicable law or agreed to in writing, software
            distributed under the License is distributed on an "AS IS" BASIS,
            WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
            See the License for the specific language governing permissions and
            limitations under the License.
        
        Changes
        =======
        
        `0.2.2 <https://github.com/SwissDataScienceCenter/renku-sphinx-theme/compare/v0.1.0...v0.2.2>`__ (2021-07-09)
        -------------------------------------------------------------------------------------------------------------
        
        -  **design:** new design for renku-sphinx
           (`3cf7ec7 <https://github.com/SwissDataScienceCenter/renku-sphinx-theme/commit/3cf7ec746996411408267cb952f500481aac805b>`__)
        
        -  **chore:** replace travis CI with github actions
           (`4056830 <https://github.com/SwissDataScienceCenter/renku-sphinx-theme/commit/40568301b0d95865db8835360b6b2ddd873ceccd>`__)
        
        `0.1.0 <https://github.com/SwissDataScienceCenter/renku-sphinx-theme/releases/tag/v0.1.0>__ (2018-05-17)`
        ---------------------------------------------------------------------------------------------------------
        
        - Initial public release.
        
Keywords: Renku Sphinx theme
Platform: any
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/x-rst
Provides-Extra: docs
Provides-Extra: dev
Provides-Extra: all
Provides-Extra: tests
