edx-sphinx-theme

edx-sphinx-theme

.. image:: https://img.shields.io/pypi/v/edx-sphinx-theme.svg :target: https://pypi.python.org/pypi/edx-sphinx-theme/ :alt: PyPI

.. image:: https://github.com/openedx/edx-sphinx-theme/workflows/Python%20CI/badge.svg?branch=master :target: https://github.com/openedx/edx-sphinx-theme/actions?query=workflow%3A%22Python+CI%22 :alt: GitHub CI

.. image:: http://codecov.io/github/edx/edx-sphinx-theme/coverage.svg?branch=master :target: http://codecov.io/github/edx/edx-sphinx-theme?branch=master :alt: Codecov

.. image:: https://readthedocs.org/projects/edx-sphinx-theme/badge/?version=latest :target: http://edx-sphinx-theme.readthedocs.io/en/latest/ :alt: Documentation

.. image:: https://img.shields.io/pypi/pyversions/edx-sphinx-theme.svg :target: https://pypi.python.org/pypi/edx-sphinx-theme/ :alt: Supported Python versions

.. image:: https://img.shields.io/github/license/edx/edx-sphinx-theme.svg :target: https://github.com/openedx/edx-sphinx-theme/blob/master/LICENSE.txt :alt: License

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.

.. _Open edX: https://open.edx.org/ .. _Sphinx: http://www.sphinx-doc.org/en/stable/

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.
• Set html_favicon to the path of the favicon.ico file in the theme.
• Use the AUTHOR constant where appropriate in conf.py (This default is only provided as a convenience. The repository is free to use another value if appropriate).
• To add an "Edit on Github" link to every page, add a dict called html_context, as detailed in the following example.

For example:

.. code-block:: python

import os
import edx_theme

extensions = ['edx_theme']

copyright = '{year}, edX Inc.'.format(year=datetime.datetime.now().year)
author = edx_theme.AUTHOR

html_theme = 'edx_theme'
html_theme_path = [edx_theme.get_html_theme_path()]
html_favicon = os.path.join(html_theme_path[0], 'edx_theme', 'static', 'css', 'favicon.ico')

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

html_context = {
    "display_github": True, # Integrate GitHub
    "github_user": "edx", # Username
    "github_repo": 'edx-sphinx-theme', # Repo name
    "github_version": "master", # Version
    "conf_py_path": "/docs/", # Path in the checkout to the docs root
}

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.

.. _Read the Docs: https://readthedocs.org/

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 <https://github.com/openedx/edx-platform/blob/master/CONTRIBUTING.rst>_ 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 [e-mail].

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.

.. _list of resources: https://open.edx.org/getting-help

Change Log

.. All enhancements and patches to edx-sphinx-theme will be documented in this file. It adheres to the structure of http://keepachangelog.com/ , but in reStructuredText instead of Markdown (for ease of incorporation into Sphinx documentation and the PyPI description).

This project adheres to Semantic Versioning (http://semver.org/).

.. There should always be an "Unreleased" section for changes pending release.

3.1.0 --- 2021-01-17

* Upgraded the `sphinx` version

3.0.0 --- 2021-07-01

• Updated to the HTML generated by docutils 0.17. What had been <div class="section"> is now <section>.

[2.1.0] - 2021-04-01

* Adding "Edit on Github" button to breadcrums.

  This should make it easier for viewers to easily correct or update bad documentation.

[2.0.0] - 2021-01-28

• Dropped Python 3.5 Support

[1.6.1] - 2020-01-19

* Fix the navigation section headers so that they are visible.

[1.6.0] - 2020-12-17

• Updated the edX logo.

[1.5.0] -2019-06-19

* Requirements Update

[1.4.0] - 2018-12-04

• Added support for the includehidden theme option. This shows a hidden toc in sidebar.

• Upgraded many dependencies.

[1.3.0] - 2017-10-13

* Added support for the ``navigation_depth`` theme option.

[1.2.0] - 2017-07-18

• The text of the help and feedback links are now variables settable in the html_context.

• Updated the copyright year.

[1.1.0] - 2017-06-28

* Supply extension metadata to enable parallel builds.

[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.