Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: deprecate edx-sphinx-theme #763

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

chore: deprecate edx-sphinx-theme #763

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d49edda
chore: deprecate edx-sphinx-theme
huniafatima-arbi Aug 7, 2024
c9792be
Merge branch 'main' into huniafatima/deprecate-edx-sphinx-theme
huniafatima-arbi Sep 2, 2024
b6953f6
Merge branch 'main' into huniafatima/deprecate-edx-sphinx-theme
huniafatima-arbi Oct 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@ build/
.coverage
dist/
/pii_report/*.yaml
docs/_build
venv
49 changes: 40 additions & 9 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@
import re
import sys
from subprocess import check_call

import edx_theme
from datetime import datetime
import sphinx_book_theme
from django import setup as django_setup


Expand Down Expand Up @@ -59,7 +59,7 @@ def get_version(*file_paths):
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'edx_theme',
'sphinx_book_theme',
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
Expand Down Expand Up @@ -90,8 +90,8 @@ def get_version(*file_paths):

# General information about the project.
project = 'edx-arch-experiments'
copyright = edx_theme.COPYRIGHT # pylint: disable=redefined-builtin
author = edx_theme.AUTHOR
copyright = f'{datetime.now().year}, edX Inc.' # pylint: disable=redefined-builtin
author ="edX Inc."
project_title = 'edx-arch-experiments'
documentation_title = f"{project_title}"

Expand Down Expand Up @@ -162,16 +162,47 @@ def get_version(*file_paths):
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.

html_theme = 'edx_theme'
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 = {}

# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = [edx_theme.get_html_theme_path()]
html_theme_options = {

"repository_url": "https://github.com/edx/edx-arch-experiments",
"repository_branch": "main",
"path_to_docs": "docs/",
"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": """
<a rel="license" href="https://creativecommons.org/licenses/by-sa/4.0/">
<img
alt="Creative Commons License"
style="border-width:0"
src="https://i.creativecommons.org/l/by-sa/4.0/80x15.png"/>
</a>
<br>
These works by
<a
xmlns:cc="https://creativecommons.org/ns#"
href="https://openedx.org"
property="cc:attributionName"
rel="cc:attributionURL"
>Axim Collaborative</a>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this appropriate for edx-arch-experiments?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(same question for license)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @timmc-edx, you are absolutely right about the Author, license and copyright information. Can I please have the exact data that we need to now add in license, author and copyright against this repo?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I heard back from Legal -- we should use edX LLC for copyright. As far as licensing, I believe it's correct to leave the docs at cc-by-sa-4, because docs.edx.org uses that in its footer. I'll check in with legal on that asynchronously, though. (It's probably not correct to have the repo licensed as AGPL or Apache but the published docs as CC, but that's probably going to be a longer conversation...)

are licensed under a
<a
rel="license"
href="https://creativecommons.org/licenses/by-sa/4.0/"
>Creative Commons Attribution-ShareAlike 4.0 International License</a>.
"""
}

html_logo = "https://logos.openedx.org/open-edx-logo-color.png"
html_favicon = "https://logos.openedx.org/open-edx-favicon.ico"

# The name for this set of Sphinx documents.
# "<project> v<release> documentation" by default.
Expand Down
2 changes: 1 addition & 1 deletion requirements/doc.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 # edX theme for Sphinx output
readme_renderer # Validates README.rst for usage on PyPI
Sphinx # Documentation builder
49 changes: 39 additions & 10 deletions requirements/doc.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
#
# This file is autogenerated by pip-compile with Python 3.11
# This file is autogenerated by pip-compile with Python 3.9
# by the following command:
#
# make upgrade
# pip-compile --output-file=requirements/doc.txt requirements/doc.in
#
accessible-pygments==0.0.5
# via pydata-sphinx-theme
alabaster==0.7.16
# via sphinx
amqp==5.2.0
Expand All @@ -20,11 +22,17 @@ attrs==24.2.0
# jsonschema
# referencing
babel==2.16.0
# via sphinx
# via
# pydata-sphinx-theme
# sphinx
beautifulsoup4==4.12.3
# via pydata-sphinx-theme
billiard==4.2.0
# via
# -r requirements/test.txt
# celery
bytecode==0.15.1

bytecode==0.15.1
# via
# -r requirements/test.txt
Expand Down Expand Up @@ -88,7 +96,6 @@ deprecated==1.2.14
django==4.2.16
# via
# -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
# -r requirements/test.txt
# django-crum
# django-waffle
# djangorestframework
Expand Down Expand Up @@ -121,6 +128,7 @@ doc8==1.1.2
docutils==0.21.2
# via
# doc8
# pydata-sphinx-theme
# readme-renderer
# restructuredtext-lint
# sphinx
Expand All @@ -141,14 +149,16 @@ edx-opaque-keys==2.11.0
# via
# -r requirements/test.txt
# edx-drf-extensions
edx-sphinx-theme==3.1.0
# via -r requirements/doc.in
edx-toggles==5.2.0
# via -r requirements/test.txt
envier==0.5.2
# via
# -r requirements/test.txt
# ddtrace
exceptiongroup==1.2.2
# via
# cattrs
# pytest
idna==3.10
# via
# -r requirements/test.txt
Expand All @@ -159,6 +169,7 @@ importlib-metadata==8.4.0
# via
# -r requirements/test.txt
# opentelemetry-api
# sphinx
iniconfig==2.0.0
# via
# -r requirements/test.txt
Expand Down Expand Up @@ -195,6 +206,7 @@ opentelemetry-api==1.27.0
packaging==24.1
# via
# -r requirements/test.txt
# pydata-sphinx-theme
# pytest
# sphinx
pbr==6.1.0
Expand All @@ -221,9 +233,13 @@ pycparser==2.22
# via
# -r requirements/test.txt
# cffi
pydata-sphinx-theme==0.15.4
# via sphinx-book-theme
pygments==2.18.0
# via
# accessible-pygments
# doc8
# pydata-sphinx-theme
# readme-renderer
# sphinx
pyjwt[crypto]==2.9.0
Expand Down Expand Up @@ -290,14 +306,17 @@ six==1.16.0
# via
# -r requirements/test.txt
# edx-codejail
# edx-sphinx-theme
# python-dateutil
snowballstemmer==2.2.0
# via sphinx
sphinx==3.5.3
soupsieve==2.5
# via beautifulsoup4
sphinx==5.3.0
# via
# -r requirements/doc.in
# edx-sphinx-theme
# pydata-sphinx-theme
# sphinx-book-theme
sphinx-book-theme==1.1.3
# via -r requirements/doc.in
sphinxcontrib-applehelp==2.0.0
# via sphinx
sphinxcontrib-devhelp==2.0.0
Expand Down Expand Up @@ -325,11 +344,21 @@ text-unidecode==1.3
# via
# -r requirements/test.txt
# python-slugify
tomli==2.0.1
# via
# coverage
# doc8
# pytest
typing-extensions==4.12.2
# via
# -r requirements/test.txt
# asgiref
# bytecode
# cattrs
# ddtrace
# edx-opaque-keys

# pydata-sphinx-theme
tzdata==2024.1
# via
# -r requirements/test.txt
Expand Down
Loading