Proposal: Remove site/ dir and flatten structure now that sphinx is no longer around
#296
Conversation
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
1 participant
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.
Initially the project was organized in such a way to separate the sphinx-y bits (Makefiles, conf.py, static, templates, etc.) from the tutorials. Now that
sphinxis no longer used, we can revisit this organization.This PR proposes to remove the
site/directory entirely; moving the few necessary files used in the website (i.e.index.mdandcontributing.md) tocontent/instead, and the_staticfolder out to the top level of the project (another option would be to merge withcontent/_static, which already exists).This has the added benefit of getting rid of all symlinks, which had caused issues for windows users in the past.
Note that this PR introduces some broken links due to the contribution guide gifs that are proposed to be removed in #294. If #294 goes in this is a non-issue, but if we decide that we like this PR but not #294 LMK and I will fix up the links.