Skip to content
This repository has been archived by the owner on Aug 21, 2024. It is now read-only.

Commit

Permalink
docs: Switch to using the edx sphinx theme.
Browse files Browse the repository at this point in the history
  • Loading branch information
feanil committed Aug 11, 2021
1 parent c057b44 commit 6e9ca72
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 7 deletions.
8 changes: 5 additions & 3 deletions docs/en_us/dashboard/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,11 @@
import os
import sys

import edx_theme
# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
html_theme = 'edx_theme'

html_theme_path = ['../../_themes']

html_favicon = '../../_themes/edx_theme/static/css/favicon.ico'
html_theme_path = [edx_theme.get_html_theme_path()]

sys.path.append(os.path.abspath('../../../'))
sys.path.append(os.path.abspath('../../'))
Expand All @@ -28,6 +27,9 @@
# so a file named "default.css" will overwrite the builtin "default.css".
# html_static_path.append('source/_static')

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['edx_theme']

# General information about the project.
project = 'Using edX Insights'
Expand Down
2 changes: 1 addition & 1 deletion requirements/doc.in
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
-r base.txt # Core dependencies of edx-analytics-dashboard

Sphinx
sphinx_rtd_theme==0.1.9
edx_sphinx_theme
7 changes: 4 additions & 3 deletions requirements/doc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,8 @@ edx-opaque-keys==2.2.2
# edx-drf-extensions
edx-rest-api-client==5.4.0
# via -r requirements/base.txt
edx-sphinx-theme==3.0.0
# via -r requirements/doc.in
edx-toggles==4.2.0
# via -r requirements/base.txt
future==0.18.2
Expand Down Expand Up @@ -308,6 +310,7 @@ six==1.16.0
# edx-django-release-util
# edx-drf-extensions
# edx-i18n-tools
# edx-sphinx-theme
# libsass
# pyjwkest
# python-dateutil
Expand All @@ -328,9 +331,7 @@ social-auth-core==3.2.0
sphinx==4.1.2
# via
# -r requirements/doc.in
# sphinx-rtd-theme
sphinx_rtd_theme==0.1.9
# via -r requirements/doc.in
# edx-sphinx-theme
sphinxcontrib-applehelp==1.0.2
# via sphinx
sphinxcontrib-devhelp==1.0.2
Expand Down

0 comments on commit 6e9ca72

Please sign in to comment.