Merge pull request #208 from openedx/feanil/update_rtd_docs

feanil/update rtd docs

.readthedocs.yaml

@@ -0,0 +1,22 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required: the version of this file's schema.
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+  fail_on_warning: true
+
+# Set the version of python needed to build these docs.
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.8"
+
+# Optionally install extra requirements required to build your docs
+python:
+  install:
+  - requirements: requirements/docs.txt

docs/source/conf.py

@@ -14,12 +14,14 @@
 
 import os
 import sys
+import django
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 sys.path.insert(0, os.path.abspath('../..'))
 os.environ.setdefault("DJANGO_SETTINGS_MODULE", "settings")
+django.setup()
 
 # -- General configuration ------------------------------------------------
 
@@ -102,7 +104,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+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
@@ -260,3 +262,41 @@
 
 # If true, do not generate a @detailmenu in the "Top" node's menu.
 #texinfo_no_detailmenu = False
+
+html_theme_options = {
+
+    "repository_url": 'https://github.com/openedx/edx-submissions',
+    "repository_branch": 'master',
+    "path_to_docs": "docs/",
+    "use_repository_button": True,
+    "use_issues_button": True,
+    "use_edit_page_button": True,
+    "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>
+        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>.
+    """
+}
+
+# Note the logo won't show up properly yet because there is an upstream
+# bug in the theme that needs to be fixed first.
+# If you'd like you can temporarily copy the logo file to your `_static`
+# directory.
+html_logo = "https://logos.openedx.org/open-edx-logo-color.png"
+html_favicon = "https://logos.openedx.org/open-edx-favicon.ico"

requirements/base.txt

@@ -6,7 +6,7 @@
 #
 asgiref==3.7.2
     # via django
-django==3.2.19
+django==3.2.20
     # via
     #   -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
     #   -r requirements/base.in
@@ -26,5 +26,5 @@ pytz==2023.3
     #   djangorestframework
 sqlparse==0.4.4
     # via django
-typing-extensions==4.6.3
+typing-extensions==4.7.1
     # via asgiref

requirements/ci.txt

@@ -4,15 +4,15 @@
 #
 #    make upgrade
 #
-certifi==2023.5.7
+certifi==2023.7.22
     # via requests
-charset-normalizer==3.1.0
+charset-normalizer==3.2.0
     # via requests
 coverage==6.5.0
     # via coveralls
 coveralls==3.3.1
     # via -r requirements/ci.in
-distlib==0.3.6
+distlib==0.3.7
     # via
     #   -r requirements/tox.txt
     #   virtualenv
@@ -29,11 +29,11 @@ packaging==23.1
     # via
     #   -r requirements/tox.txt
     #   tox
-platformdirs==3.5.3
+platformdirs==3.10.0
     # via
     #   -r requirements/tox.txt
     #   virtualenv
-pluggy==1.0.0
+pluggy==1.2.0
     # via
     #   -r requirements/tox.txt
     #   tox
@@ -55,9 +55,9 @@ tox==3.28.0
     # via
     #   -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
     #   -r requirements/tox.txt
-urllib3==2.0.3
+urllib3==2.0.4
     # via requests
-virtualenv==20.23.0
+virtualenv==20.24.2
     # via
     #   -r requirements/tox.txt
     #   tox