Package: edx-sphinx-theme
edx-sphinx-theme is a Sphinx theme forOpen edXdocumentation.  It should be
used for all documentation in repositories in theedxGitHub organization
which is intended to be used with theSphinxdocumentation system.OverviewThis theme makes the following changes to the default Sphinx output:Displays the edX logoAdds a link to a feedback form that identifies which page the feedback came fromTo use edx-sphinx-theme for a repository’s documentation:pip installedx-sphinx-themeor equivalent (addedx-sphinx-themeto any appropriate requirements files)Addedx_themeto theextensionslist in conf.py (it adds the feedback form URL to the rendering context for each page).Update thehtml_themeandhtml_theme_pathvalues in conf.py so the theme can be located and loaded.Sethtml_faviconto the path of the favicon.ico file in the theme.Use theAUTHORconstant 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 calledhtml_context, as detailed in the following example.For example:importosimportedx_themeextensions=['edx_theme']copyright='{year}, edX Inc.'.format(year=datetime.datetime.now().year)author=edx_theme.AUTHORhtml_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 ConfigurationBecause this theme is a Python package which needs to be installed,Read the
Docsneeds to be configured appropriately to be able to install it when
performing documentation builds.  UnderAdvanced Settings:Install your project inside a virtualenv using setup.py installshould
be checkedRequirements fileshould point to a pip requirements file which includesopen-edx-theme.DocumentationThe full documentation is athttps://edx-sphinx-theme.readthedocs.org.LicenseThe code in this repository is licensed under the Apache Software License 2.0 unless
otherwise noted.Please seeLICENSE.txtfor details.How To ContributeContributions are very welcome.Please readHow To Contributefor details.Even though they were written withedx-platformin mind, the guidelines
should be followed for Open edX code in general.Reporting Security IssuesPlease do not report security issues in public. Please emailsecurity@edx.org.Getting HelpHave a question about this repository, or about Open edX in general?  Please
refer to thislist of resourcesif you need any assistance.Change Log3.1.0 — 2021-01-17Upgraded thesphinxversion3.0.0 — 2021-07-01Updated to the HTML generated by docutils 0.17.  What had been<divclass="section">is now<section>.[2.1.0] - 2021-04-01Adding “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-28Dropped Python 3.5 Support[1.6.1] - 2020-01-19Fix the navigation section headers so that they are visible.[1.6.0] - 2020-12-17Updated the edX logo.[1.5.0] -2019-06-19Requirements Update[1.4.0] - 2018-12-04Added support for theincludehiddentheme option. This shows a hidden toc
in sidebar.Upgraded many dependencies.[1.3.0] - 2017-10-13Added support for thenavigation_depththeme option.[1.2.0] - 2017-07-18The text of the help and feedback links are now variables settable in the
html_context.Updated the copyright year.[1.1.0] - 2017-06-28Supply extension metadata to enable parallel builds.[1.0.2] - 2016-11-09Added favicon and .eot font file to distributed package.[1.0.1] - 2016-10-14Fixed two instances of line-height being slightly increased in an ugly way.[1.0] - 2016-10-07AddedFirst release on PyPI.