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

Group development related files together #2426

Merged
merged 4 commits into from Oct 17, 2020
Merged

Group development related files together #2426

merged 4 commits into from Oct 17, 2020

Conversation

alvyjudy
Copy link
Contributor

Summary of changes

Built on top of #2425 , I modified the file position for development related docs and referenced them from the top index:

docs/
    index.rst (toc tree now points to development/index.rst)
    development/
        index.rst (originally development.rst)
        developer-guide.rst
        releases.rst
        history.rst

Note: I think this means the github PR prompt will also have to be modified as it points toward the developer-guide ( https://setuptools.readthedocs.io/en/latest/developer-guide.html) that is now in a different position

Pull Request Checklist

  • Changes have tests
  • News fragment added in changelog.d. See documentation for details

docs/index.rst Outdated Show resolved Hide resolved
@webknjaz
Copy link
Member

@alvyjudy

Note: I think this means the github PR prompt will also have to be modified as it points toward the developer-guide ( setuptools.readthedocs.io/en/latest/developer-guide.html) that is now in a different position

In this case, the change to .github/pull_request_template.md should be included in this PR so that it's atomic.
Another question that arises with relation to nesting: wouldn't it be better to switch to dirhtml Sphinx builder. It'd produce nicer URLs on RTD and would help with moves like this. cc @jaraco

P.S. This probably deserves a change fragment: https://github.com/pypa/setuptools/tree/master/changelog.d.

@alvyjudy
Copy link
Contributor Author

alvyjudy commented Oct 15, 2020

@webknjaz regarding the changelog, @jaraco mentioned that it might not be necessary to put changelog to different phases of doc I'm not sure if we should add one here?

Thanks for the review :) See below for the changes.

@webknjaz
Copy link
Member

@alvyjudy the changelog is indeed optional for non-essential changes but it's my personal opinion that it's nice to have it most of the time. It's totally up to you, though.

@webknjaz
Copy link
Member

I've also noticed that format got renamed into deprecated/python_eggs but is still linked as "format" in TOC in development.rst. I'm trying to set up a strict mode for #2424 and discovered this among other missing references. Your move of development.rst in this PR is also going to break some of the links so please check the toctree in the new location, you'll probably need to take care of some other entries there too.

@webknjaz
Copy link
Member

@alvyjudy hey, my PR has been accepted and yours now has conflicts. I'm not planning to submit any more substantial changes in the near future so it's safe for you to solve the conflicts/do rebase. Please also note that you'll probably need to update the PR description to match what's actually in the PR ✌️

@jaraco jaraco merged commit edd84c8 into pypa:master Oct 17, 2020
webknjaz added a commit to webknjaz/setuptools that referenced this pull request Oct 17, 2020
This change corrects the typo introduced by pypa#2426.
webknjaz added a commit to webknjaz/setuptools that referenced this pull request Oct 17, 2020
This is necessary because the document has been moved in PR pypa#2426.
webknjaz added a commit to webknjaz/setuptools that referenced this pull request Oct 17, 2020
This is necessary because the document has been moved in PR pypa#2426.
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.

None yet

3 participants