A Sphinx theme for Open edX documentation
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_path()]
latex_documents = [
(master_doc, 'edx-sphinx-theme.tex', 'edx-sphinx-theme Documentation',
author, 'manual'),
]
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] - 2016-10-06
Added
First release on PyPI.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for edx_sphinx_theme-1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a068a3a91d73a6d1071785152db0e1771ae59467c6513bc46441b84b132a53eb |
|
MD5 | b95b47fb8934673f9a2ccaa0e125fdae |
|
BLAKE2b-256 | cf725e4863feb66559723c1bf9104560384be33f55d572bea5e0a19eb2bc73f3 |