A Sphinx theme for Open edX documentation
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.
This theme makes the following changes to the default Sphinx output:
To use edx-sphinx-theme for a repository’s documentation:
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'), ]
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:
The full documentation is at https://edx-sphinx-theme.readthedocs.org.
The code in this repository is licensed under the Apache Software License 2.0 unless otherwise noted.
Please see LICENSE.txt for details.
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.
Please do not report security issues in public. Please email firstname.lastname@example.org.
Have a question about this repository, or about Open edX in general? Please refer to this list of resources if you need any assistance.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|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|