Git Product home page Git Product logo

adctheme's Introduction

How To Install

Install in Sphinx

Copy this directory into the sphinx/themes directory where Sphinx is installed. For example, a standard install of sphinx on Mac OS X is at /Library/Python/2.6/site-packages/

Install Somewhere Else

If you want to install this theme somewhere else, you will have to modify the conf.py file. :

templates_path = ['/absolute/path/to/dir/','relative/path/']

Install Directly in Your Documentation

If you want to include the files directly in the documentation, so another person can build your documentation, it is easy.

  1. Copy over everything in the static directory into the _static directory of your documentation's source folder.
  2. Copy the layout.html file into the _templates directory of your documentation's source folder.
  3. Alter your conf.py :

    html_theme = 'basic'
    html_style = 'adctheme.css'

    instead of 'ADCtheme'.

Making Sphinx Use the Theme

If you aren't installing the files directly into your documentation, edit the conf.py file and make the following setting: :

html_theme = 'ADCtheme'

Screen Shots

image

image

To Do

  • Gotta get the javascript working so the Table of Contents is hide-able.
  • Probably lots of css cleanup.

adctheme's People

Contributors

coordt avatar defunkt avatar ekalinin avatar evandrix avatar jszakmeister avatar nvie avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.