Skip to content

Commit

Permalink
fix: docs build issues (#35978)
Browse files Browse the repository at this point in the history
  • Loading branch information
irtazaakram authored Dec 6, 2024
1 parent 38f7344 commit e3d7f66
Show file tree
Hide file tree
Showing 8 changed files with 310 additions and 40 deletions.
24 changes: 15 additions & 9 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.coverage',
'sphinx.ext.doctest',
'sphinx.ext.graphviz',
Expand All @@ -68,8 +67,22 @@
'sphinx_design',
'code_annotations.contrib.sphinx.extensions.featuretoggles',
'code_annotations.contrib.sphinx.extensions.settings',
# 'autoapi.extension', # Temporarily disabled
]

# Temporarily disabling autoapi_dirs and the AutoAPI extension due to performance issues.
# This will unblock ReadTheDocs builds and will be revisited for optimization.
# autoapi_type = 'python'
# autoapi_dirs = ['../lms/djangoapps', '../openedx/core/djangoapps', "../openedx/features"]
#
# autoapi_ignore = [
# '*/migrations/*',
# '*/tests/*',
# '*.pyc',
# '__init__.py',
# '**/xblock_serializer/data.py',
# ]

# Rediraffe related settings.
rediraffe_redirects = "redirects.txt"
rediraffe_branch = 'origin/master'
Expand Down Expand Up @@ -274,16 +287,9 @@

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {
'django': ('https://docs.djangoproject.com/en/1.11/', 'https://docs.djangoproject.com/en/1.11/_objects/'),
'django': ('https://docs.djangoproject.com/en/4.2/', 'https://docs.djangoproject.com/en/4.2/_objects/'),
}

# Mock out these external modules during code import to avoid errors
autodoc_mock_imports = [
'MySQLdb',
'django_mysql',
'pymongo',
]

# Start building a map of the directories relative to the repository root to
# run sphinx-apidoc against and the directories under "docs" in which to store
# the generated *.rst files
Expand Down
Loading

0 comments on commit e3d7f66

Please sign in to comment.