Skip to content

docs: point the XBlock Aside cross-references at real targets - #1522

Open
rawsun007 wants to merge 1 commit into
openedx:mainfrom
rawsun007:docs/fix-xblock-aside-crossrefs
Open

rawsun007 wants to merge 1 commit into
openedx:mainfrom
rawsun007:docs/fix-xblock-aside-crossrefs

Conversation

@rawsun007

Copy link
Copy Markdown
Contributor

Six cross-references on the two XBlock Aside pages render as plain text instead of links. xblock is in intersphinx_mapping, but these names are not in its inventory:

written in the xblock inventory
:func: xblock.core.XBlockAside.aside_for py:method — needs :meth:
xblock.scopes.ScopeIds xblock.fields.ScopeIds
XBlockAside (3×) xblock.core.XBlockAside
Fragment web_fragments.fragment.Fragment

Each now uses the ~ form, so the displayed text is unchanged and only the link is added.

The normal build does not report these, because an unresolved Python-domain reference is only a warning under -n. With sphinx-build -n the tree goes from 8 warnings to 2, and the two left are graphviz not being installed on my machine. The built pages now carry the links, e.g. xblock.html#xblock.core.XBlockAside.

Written with Claude Code (Claude Opus 5.5).

🤖 Generated with Claude Code

Six references rendered as plain text because they did not resolve
through the xblock intersphinx inventory: ScopeIds lives in
xblock.fields, aside_for is a method, and XBlockAside and Fragment
needed their modules.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @rawsun007!

This repository is currently maintained by @openedx/wg-maintenance-docs.openedx.org.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Sep 23, 2026
@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Sep 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: Needs Triage

Development

Successfully merging this pull request may close these issues.

2 participants