Skip to content

Remove some unneeeded sphinx-asdf directives#2057

Open
braingram wants to merge 6 commits into
asdf-format:mainfrom
braingram:sphinx_asdf_usage
Open

Remove some unneeeded sphinx-asdf directives#2057
braingram wants to merge 6 commits into
asdf-format:mainfrom
braingram:sphinx_asdf_usage

Conversation

@braingram
Copy link
Copy Markdown
Contributor

@braingram braingram commented Jun 1, 2026

Description

Remove use of 2 sphinx-asdf directives:

  • asdf : replaced with inline copies of produced files
  • runcode : replaced with code blocks (executed as doctests)

Neither of the above is used outside of asdf so once we merge this we can remove those directives from sphinx-asdf.

To get the doctests to behave locally I needed to:

  • introduce a tmp_cwd fixture for doctests to run them in a temporary directory
  • rename the docs/asdf folder to docs/_asdf to avoid import confusion where doctests were trying to import docs/asdf as if it were an asdf module

Here are some of the changed pages:

pytestdev failure is unrelated: #2055

Tasks

  • run prek on your machine
  • run pytest on your machine
  • Does this PR add new features and / or change user-facing code / API? (if not, label with no-changelog-entry-needed)
    • write news fragment(s) in changes/: echo "changed something" > changes/<PR#>.<changetype>.rst (see below for change types)
    • update relevant docstrings and / or docs/ page
    • for any new features, add unit tests
news fragment change types...
  • changes/<PR#>.feature.rst: new feature
  • changes/<PR#>.bugfix.rst: bug fix
  • changes/<PR#>.doc.rst: documentation change
  • changes/<PR#>.removal.rst: deprecation or removal of public API
  • changes/<PR#>.general.rst: infrastructure or miscellaneous change

@braingram braingram force-pushed the sphinx_asdf_usage branch from 2a4c5af to 24ee619 Compare June 1, 2026 17:56
@braingram braingram marked this pull request as ready for review June 1, 2026 20:03
@braingram braingram requested a review from a team as a code owner June 1, 2026 20:03
@braingram braingram mentioned this pull request Jun 1, 2026
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant