diff --git a/docs/conf.py b/docs/conf.py index e7eaac4a..06e35fb9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -107,12 +107,42 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = "alabaster" +html_theme = 'sphinx_book_theme' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -# html_theme_options = {} +html_theme_options = { + "repository_url": "https://github.com/openedx/edx-repo-health", + "repository_branch": "master", + "path_to_docs": "docs/", + "home_page_in_toc": True, + "use_repository_button": True, + "use_issues_button": True, + "use_edit_page_button": True, + # Please don't change unless you know what you're doing. + "extra_footer": """ + + Creative Commons License + +
+ These works by + Axim Collaborative, Inc + are licensed under a + Creative Commons Attribution-ShareAlike 4.0 International License. + """ +} # Add any paths that contain custom themes here, relative to this directory. # html_theme_path = [] diff --git a/requirements/doc.in b/requirements/doc.in index bee70ef8..ddb4e07f 100644 --- a/requirements/doc.in +++ b/requirements/doc.in @@ -4,6 +4,6 @@ -r test.txt # Core and testing dependencies for this package doc8 # reStructuredText style checker -edx_sphinx_theme # edX theme for Sphinx output +sphinx-book-theme # Common theme for all Open edX projects readme_renderer # Validates README.rst for usage on PyPI Sphinx # Documentation builder \ No newline at end of file diff --git a/requirements/doc.txt b/requirements/doc.txt index 7566b8fc..68308cec 100644 --- a/requirements/doc.txt +++ b/requirements/doc.txt @@ -4,6 +4,8 @@ # # make upgrade # +accessible-pygments==0.0.4 + # via pydata-sphinx-theme aiohttp==3.8.4 # via # -r requirements/test.txt @@ -24,7 +26,11 @@ attrs==22.2.0 # -r requirements/test.txt # aiohttp babel==2.12.1 - # via sphinx + # via + # pydata-sphinx-theme + # sphinx +beautifulsoup4==4.12.2 + # via pydata-sphinx-theme bleach==6.0.0 # via readme-renderer cachetools==5.3.0 @@ -51,11 +57,10 @@ dockerfile==3.2.0 docutils==0.19 # via # doc8 + # pydata-sphinx-theme # readme-renderer # restructuredtext-lint # sphinx -edx-sphinx-theme==3.1.0 - # via -r requirements/doc.in exceptiongroup==1.1.1 # via # -r requirements/test.txt @@ -116,6 +121,7 @@ packaging==21.3 # via # -c requirements/constraints.txt # -r requirements/test.txt + # pydata-sphinx-theme # pytest # sphinx pbr==5.11.1 @@ -133,9 +139,13 @@ pyasn1-modules==0.2.8 # via # -r requirements/test.txt # google-auth +pydata-sphinx-theme==0.13.3 + # via sphinx-book-theme pygments==2.15.0 # via + # accessible-pygments # doc8 + # pydata-sphinx-theme # readme-renderer # sphinx pyparsing==3.0.9 @@ -192,7 +202,6 @@ six==1.16.0 # via # -r requirements/test.txt # bleach - # edx-sphinx-theme # google-auth smmap==5.0.0 # via @@ -200,11 +209,16 @@ smmap==5.0.0 # gitdb snowballstemmer==2.2.0 # via sphinx +soupsieve==2.4.1 + # via beautifulsoup4 sphinx==5.3.0 # via # -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt # -r requirements/doc.in - # edx-sphinx-theme + # pydata-sphinx-theme + # sphinx-book-theme +sphinx-book-theme==1.0.1 + # via -r requirements/doc.in sphinxcontrib-applehelp==1.0.4 # via sphinx sphinxcontrib-devhelp==1.0.2 @@ -229,6 +243,8 @@ types-pyyaml==6.0.12.9 # via # -r requirements/test.txt # responses +typing-extensions==4.5.0 + # via pydata-sphinx-theme urllib3==1.26.15 # via # -r requirements/test.txt