1.. index:: cloud; installation 2 3========================= 4Installation Instructions 5========================= 6 7Requirements 8============ 9* Python >= 2.6 or Python 3 10* `Sphinx <http://sphinx.pocoo.org/>`_ 1.4 or newer. 11 12Installing 13========== 14* To install from pypi using pip:: 15 16 pip install cloud_sptheme 17 18* To install from pypi using easy_install:: 19 20 easy_install cloud_sptheme 21 22* To install from source using ``setup.py``:: 23 24 python setup.py build 25 sudo python setup.py install 26 27.. index:: readthedocs.org; installation on 28 29ReadTheDocs 30=========== 31To use this theme on `<https://readthedocs.org>`_: 32 331. If it doesn't already exist, add a pip ``requirements.txt`` file to your documentation (e.g. alongside ``conf.py``). 34 It should contain a minimum of the following lines:: 35 36 sphinx 37 cloud_sptheme 38 39 ... as well as any other build requirements for your project's documentation. 40 412. When setting up your project on ReadTheDocs, enter the path to ``requirements.txt`` 42 in the *requirements file* field on the project configuration page. 43 443. ReadTheDocs will now automatically download the latest version of :mod:`!cloud_sptheme` 45 when building your documentation. 46 47Documentation 48============= 49The latest copy of this documentation should always be available at: 50 `<https://cloud-sptheme.readthedocs.io>`_ 51 52If you wish to generate your own copy of the documentation, 53you will need to: 54 551. Install `Sphinx <http://sphinx.pocoo.org/>`_ (1.4 or better) 562. Download the :mod:`!cloud_sptheme` source. 573. From the source directory, run ``python setup.py build_sphinx -E``. 584. Once Sphinx is finished, point a web browser to the file :samp:`{SOURCE}/build/sphinx/html/index.html`. 59