Skip to main content

Apple Developer Connection theme for Sphinx, 2015 version.

Project description

https://travis-ci.org/mga-sphinx/sphinx_adc_theme.svg?branch=master

This is a sphinx theme that made for adc.

Check demo

Installation

Via package

Download the package or add it to your requirements.txt file:

$ pip install sphinx_adc_theme

In your conf.py file:

import sphinx_adc_theme

html_theme = "sphinx_adc_theme"

html_theme_path = [sphinx_adc_theme.get_html_theme_path()]

Via git or download

Symlink or subtree the sphinx_adc_theme/sphinx_adc_theme repository into your documentation at docs/_themes/sphinx_adc_theme then add the following two settings to your Sphinx conf.py file:

html_theme = "sphinx_adc_theme"
html_theme_path = ["_themes", ]

Changelog

See CHANGELOG.rst file

Contributing or modifying the theme

The sphinx_adc_theme is primarily a sass project that requires a few other sass libraries. I’m using bower to manage these dependencies and sass to build the css. The good news is I have a very nice set of grunt operations that will not only load these dependencies, but watch for changes, rebuild the sphinx demo docs and build a distributable version of the theme. The bad news is this means you’ll need to set up your environment similar to that of a front-end developer (vs. that of a python developer). That means installing node and ruby.

Set up your environment

  1. Install sphinx into a virtual environment.
pip install sphinx
  1. Install sass
gem install sass
  1. Install node, bower and grunt.
// Install node
brew install node

// Install bower and grunt
npm install -g bower grunt-cli

// Now that everything is installed, let's install the theme dependecies.
npm install

Now that our environment is set up, make sure you’re in your virtual environment, go to this repository in your terminal and run grunt:

grunt

This default task will do the following very cool things that make it worth the trouble.

  1. It’ll install and update any bower dependencies.
  2. It’ll run sphinx and build new docs.
  3. It’ll watch for changes to the sass files and build css from the changes.
  4. It’ll rebuild the sphinx docs anytime it notices a change to .rst, .html, .js or .css files.

Before you create an issue

I don’t have a lot of time to maintain this project due to other responsibilities. I know there are a lot of Python engineers out there that can’t code sass / css and are unable to submit pull requests. That said, submitting random style bugs without at least providing sample documentation that replicates your problem is a good way for me to ignore your request. RST unfortunately can spit out a lot of things in a lot of ways. I don’t have time to research your problem for you, but I do have time to fix the actual styling issue if you can replicate the problem for me.

Before you send a Pull Request

When you’re done with your edits, you can run grunt build to clean out the old files and rebuild a new distribution, compressing the css and cleaning out extraneous files. Please do this before you send in a PR.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinx_adc_theme, version 0.1.6.1
Filename, size File type Python version Upload date Hashes
Filename, size sphinx_adc_theme-0.1.6.1-py2.py3-none-any.whl (238.5 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size sphinx_adc_theme-0.1.6.1.tar.gz (239.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page