Skip to content

Split source directory into guides and reference - #1802

Merged
srittau merged 2 commits into
python:mainfrom
srittau:guides-dir
Jul 15, 2024
Merged

srittau merged 2 commits into
python:mainfrom
srittau:guides-dir

Conversation

@srittau

@srittau srittau commented Jul 15, 2024 •

Copy link
Copy Markdown
Collaborator

This brings order into both the repository, but also the URL structure by replacing the meaningless "source" component in the URL. This also means that e.g. https://typing.readthedocs.io/en/latest/guides/ will be a guide index, instead of https://typing.readthedocs.io/en/latest/source/guides.html which then links to other documents in the "source" directory.


Depends on #1801.


DON'T MERGE, just approve please. If this gets approved, I will merge it and add redirects in the readthedocs config from the old paths to the new paths.

@srittau
srittau marked this pull request as ready for review July 15, 2024 12:05

@JelleZijlstra JelleZijlstra left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Every time I look at this repo I am confused about what "source" means.

@srittau
srittau merged commit 42e9118 into python:main Jul 15, 2024
@srittau
srittau deleted the guides-dir branch July 15, 2024 14:49
@srittau

srittau commented Jul 15, 2024 •

Copy link
Copy Markdown
Collaborator Author

Done and redirects added.

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