README.rst 949 B

1234567891011121314151617181920212223242526272829303132333435
  1. ==============
  2. How To Install
  3. ==============
  4. Install in Sphinx
  5. -----------------
  6. Copy this directory into the ``sphinx/templates`` directory where Shpinx is installed. For example, a standard install of sphinx on Mac OS X is at ``/Library/Python/2.6/site-packages/Sphinx-0.6.3-py2.6.egg/``
  7. Install Somewhere Else
  8. ----------------------
  9. If you want to install this theme somewhere else, you will have to modify the ``conf.py`` file. ::
  10. templates_path = ['/absolute/path/to/dir/','relative/path/']
  11. Making Sphinx Use the Theme
  12. ---------------------------
  13. Edit the ``conf.py`` file and make the following setting: ::
  14. html_theme = 'ADCtheme'
  15. Screen Shots
  16. ------------
  17. .. image:: http://github.com/coordt/ADCtheme/raw/master/static/scrn1.png
  18. .. image:: http://github.com/coordt/ADCtheme/raw/master/static/scrn2.png
  19. To Do
  20. -----
  21. * Gotta get the javascript working so the Table of Contents is hide-able.
  22. * Probably lots of css cleanup.