Flatten directory structure: get rid of site/
and move website to top-level
#169
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.
This is an idea inspired by #89. Currently, all the (non-executable) markdown source files for the website are stored in the
site/
directory to keep the top-level directory tidy. However, the current organization also has unintended consequences, mostly due to the symbolic link back to thecontent/
dir:The simplest way to fix the above issues would be to just do away with the
site/
directory. That's what this PR proposes. The main downside is that the top-level directory becomes much more cluttered with sphinx-specific files/folders (e.g._static
) and site-specific files (e.g. all the.md
files).Are the benefits worth the tradeoff? Let me know what you think! In the meantime, I'm marking this as a draft.
PS - the diff is not very useful: you really need to be able to compare the old structure to the new. The easiest way to do so would be:
You can then bounce between
main
andflatten-dir-structure
to see the impact on the top-level directory.