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

docs(examples) Remove source from documentation build #4595

Closed
wants to merge 3 commits into from

Conversation

chongshenng
Copy link
Contributor

@chongshenng chongshenng commented Nov 27, 2024

Currently, _sources/ is included when building the documentation for our examples. This PR adds html_copy_source = False which instructs Sphinx not to include the source files in the output.

@chongshenng chongshenng changed the title doc(examples) Remove source from documentation build docs(examples) Remove source from documentation build Nov 27, 2024
@chongshenng chongshenng marked this pull request as ready for review November 27, 2024 14:56
charlesbvll
charlesbvll previously approved these changes Nov 27, 2024
@chongshenng
Copy link
Contributor Author

It turns out that _sources is used to host the original .rst or .md source files so that users can view the page source by clicking on the "View this page" icon on the top right.

For example, clicking on that icon for the Quickstart PyTorch example will lead to it's source here.

This has utility for some users who want to refer to the source of the page, so I'm closing this PR for now.

image

@chongshenng chongshenng closed this Jan 6, 2025
@chongshenng chongshenng deleted the remove-doc-source branch January 6, 2025 10:10
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.

2 participants