Rename doc file extension from .md to .mdx#691
Merged
albertvillanova merged 2 commits intohuggingface:mainfrom Feb 18, 2025
Merged
Rename doc file extension from .md to .mdx#691albertvillanova merged 2 commits intohuggingface:mainfrom
albertvillanova merged 2 commits intohuggingface:mainfrom
Conversation
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
Member
Author
|
Failing test is unrelated to this PR. |
aymeric-roucher
approved these changes
Feb 18, 2025
Collaborator
aymeric-roucher
left a comment
There was a problem hiding this comment.
Thank you! Out of curiosity, why make this change?
Member
Author
|
@pytest.mark.skipif(not os.getenv("RUN_ALL"), reason="RUN_ALL environment variable not set")
class TestDocs:
"""Test case for documentation code testing."""
@classmethod
def setup_class(cls):
cls._tmpdir = tempfile.mkdtemp()
cls.launch_args = ["python3"]
cls.docs_dir = Path(__file__).parent.parent / "docs" / "source" / "en"
cls.extractor = DocCodeExtractor()
if not cls.docs_dir.exists():
raise ValueError(f"Docs directory not found at {cls.docs_dir}")
load_dotenv()
cls.md_files = list(cls.docs_dir.rglob("*.mdx")) # <- this needs to be changed too
if not cls.md_files:
raise ValueError(f"No markdown files found in {cls.docs_dir}") |
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rename docs files extension from .md to .mdx.
Note that the automatic conversion of doc files to notebooks searches for
.mdxfiles.Fix #690.