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

fix: failing Docs Builds #35846

Merged
merged 1 commit into from
Nov 18, 2024
Merged

fix: failing Docs Builds #35846

merged 1 commit into from
Nov 18, 2024

Conversation

irtazaakram
Copy link
Member

@irtazaakram irtazaakram marked this pull request as ready for review November 15, 2024 06:58
@irtazaakram irtazaakram requested a review from a team as a code owner November 15, 2024 06:58
irtazaakram
irtazaakram commented Nov 15, 2024
View reviewed changes
openedx/core/djangoapps/user_api/accounts/utils.py
Comment on lines +54 to +58
Returns:
- An empty string if `new_social_link` is empty.
- A formatted URL if `new_social_link` is a username.
- Returns `new_social_link` if it is a valid URL.
- None for unparseable inputs.
Copy link
Member Author

Choose a reason for hiding this comment

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

Fixes: ValueError: 'platform_name_base' does not appear to be an IPv4 or IPv6 address

irtazaakram
irtazaakram commented Nov 15, 2024
View reviewed changes
docs/conf.py
]

autoapi_type = 'python'
autoapi_dirs = ['../lms', '../openedx']
Copy link
Member Author

Choose a reason for hiding this comment

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

This is inline with settings here:

edx-platform/docs/conf.py

Lines 290 to 299 in 1b405af

modules = {
'lms': 'references/docstrings/lms',
'openedx': 'references/docstrings/openedx',
# Commenting this out for now because they blow up the build
# time and memory limits for RTD. We can come back to these
# later once we get parallel builds working hopefully.
# 'cms': 'references/docstrings/cms',
# 'common': 'references/docstrings/common',
# 'xmodule': 'references/docstrings/xmodule',
}

@feanil
Copy link
Contributor

feanil commented Nov 15, 2024

@irtazaakram I'm still seeing the following error when I run make docs

Extension error (autoapi.extension):
Handler <function run_autoapi at 0x7a41042537e0> for event 'builder-inited' threw an exception (exception: 'list' object has no attribute 'get_children')
make: *** [Makefile:22: html] Error 2

@irtazaakram irtazaakram marked this pull request as draft November 15, 2024 18:19
irtazaakram
irtazaakram commented Nov 15, 2024
View reviewed changes
docs/conf.py
'*/tests/*',
'*.pyc',
'__init__.py',
'**/xblock_serializer/data.py',
Copy link
Member Author

Choose a reason for hiding this comment

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

Temporary workaround as It requires too many changes here to be able to build using autoapi.

@irtazaakram irtazaakram marked this pull request as ready for review November 15, 2024 18:37
@irtazaakram irtazaakram merged commit 68a626a into openedx:master Nov 18, 2024
51 checks passed
@irtazaakram irtazaakram deleted the fix35807 branch November 18, 2024 06:30
@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

1 similar comment
@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

@farhaanbukhsh farhaanbukhsh mentioned this pull request Nov 19, 2024
Open
11 tasks
@mariajgrimaldi mariajgrimaldi mentioned this pull request Nov 26, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@feanil feanil feanil approved these changes

@deborahgu deborahgu deborahgu approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Fix Failing edx-platform Docs Builds
4 participants
@irtazaakram @feanil @edx-pipeline-bot @deborahgu