This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project Description

edx-sphinx-theme is a Sphinx theme for Open edX documentation. It should be used for all documentation in repositories in the edx GitHub organization which is intended to be used with the Sphinx documentation system.

Overview

This theme makes the following changes to the default Sphinx output:

  • Displays the edX logo
  • Adds a link to a feedback form that identifies which page the feedback came from

To use edx-sphinx-theme for a repository’s documentation:

  • pip install edx-sphinx-theme or equivalent (add edx-sphinx-theme to any appropriate requirements files)
  • Add edx_theme to the extensions list in conf.py (it adds the feedback form URL to the rendering context for each page).
  • Update the html_theme and html_theme_path values in conf.py so the theme can be located and loaded.
  • Use the AUTHOR and COPYRIGHT constants where appropriate in conf.py (these defaults are only provided as a convenience, the repository is free to use other values if appropriate).

For example:

import edx_theme

extensions = ['edx_theme']

copyright = edx_theme.COPYRIGHT
author = edx_theme.AUTHOR

html_theme = 'edx_theme'
html_theme_path = [edx_theme.get_html_theme_path()]

latex_documents = [
    (master_doc, 'edx-sphinx-theme.tex', 'edx-sphinx-theme Documentation',
     author, 'manual'),
]

Read the Docs Configuration

Because this theme is a Python package which needs to be installed, Read the Docs needs to be configured appropriately to be able to install it when performing documentation builds. Under Advanced Settings:

  • Install your project inside a virtualenv using setup.py install should be checked
  • Requirements file should point to a pip requirements file which includes open-edx-theme.

Documentation

The full documentation is at https://edx-sphinx-theme.readthedocs.org.

License

The code in this repository is licensed under the Apache Software License 2.0 unless otherwise noted.

Please see LICENSE.txt for details.

How To Contribute

Contributions are very welcome.

Please read How To Contribute for details.

Even though they were written with edx-platform in mind, the guidelines should be followed for Open edX code in general.

Reporting Security Issues

Please do not report security issues in public. Please email security@edx.org.

Getting Help

Have a question about this repository, or about Open edX in general? Please refer to this list of resources if you need any assistance.

Change Log

Unreleased

[1.0.2] - 2016-11-09

  • Added favicon and .eot font file to distributed package

[1.0.1] - 2016-10-14

  • Fixed two instances of line-height being slightly increased in an ugly way.

[1.0] - 2016-10-07

Added

  • First release on PyPI.
Release History

Release History

1.0.2

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

1.0.1

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

1.0

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
edx_sphinx_theme-1.0.2-py2.py3-none-any.whl (216.9 kB) Copy SHA256 Checksum SHA256 py2.py3 Wheel Nov 9, 2016
edx-sphinx-theme-1.0.2.tar.gz (219.8 kB) Copy SHA256 Checksum SHA256 Source Nov 9, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS HPE HPE Development Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting