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.

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

Fix readthedocs build fail #35978

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
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
Loading