-
Notifications
You must be signed in to change notification settings - Fork 970
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
Restructure table of contents, section indices, and landing page #1409
Open
willingc
wants to merge
3
commits into
pypa:main
Choose a base branch
from
willingc:index-simple
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+73
−52
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@@ -1,8 +1,8 @@ | ||||||||||||||
.. |PyPUG| replace:: Python Packaging User Guide | ||||||||||||||
|
||||||||||||||
************************ | ||||||||||||||
Contribute to this guide | ||||||||||||||
************************ | ||||||||||||||
************ | ||||||||||||||
Contributing | ||||||||||||||
************ | ||||||||||||||
Comment on lines
+3
to
+5
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I agree with @webknjaz on that.
Suggested change
|
||||||||||||||
|
||||||||||||||
The |PyPUG| welcomes contributors! There are lots of ways to help out, | ||||||||||||||
including: | ||||||||||||||
|
This file contains 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
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -10,53 +10,42 @@ Python Packaging User Guide | |||||
:maxdepth: 2 | ||||||
:hidden: | ||||||
|
||||||
overview | ||||||
flow | ||||||
overview/index | ||||||
tutorials/index | ||||||
guides/index | ||||||
discussions/index | ||||||
specifications/index | ||||||
key_projects | ||||||
glossary | ||||||
support | ||||||
references/index | ||||||
contribute | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
news | ||||||
|
||||||
Welcome to the *Python Packaging User Guide*, a collection of tutorials and | ||||||
references to help you distribute and install Python packages with modern | ||||||
tools. | ||||||
Welcome to the *Python Packaging User Guide*. | ||||||
This collection of tutorials, how-to guides, explanations, specifications, and | ||||||
references is a central place to learn about Python packages, how to distribute | ||||||
and install libraries and projects, and build awareness of available modern tools. | ||||||
|
||||||
This guide is maintained on `GitHub`_ by the :doc:`Python Packaging Authority <pypa:index>`. We | ||||||
happily accept :doc:`contributions and feedback <contribute>`. 😊 | ||||||
This guide is maintained on `GitHub`_ by the :doc:`Python Packaging Authority <pypa:index>`. | ||||||
We encourage and happily accept :doc:`contributions <contribute>`. 😊 | ||||||
|
||||||
.. _GitHub: https://github.com/pypa/packaging.python.org | ||||||
|
||||||
|
||||||
Overview and Flow | ||||||
================= | ||||||
Overview | ||||||
======== | ||||||
|
||||||
.. note:: | ||||||
|
||||||
Building your understanding of Python packaging is a journey. Patience and | ||||||
continuous improvement are key to success. The overview and flow sections | ||||||
provide a starting point for understanding the Python packaging ecosystem. | ||||||
|
||||||
The :doc:`overview` explains Python packaging | ||||||
The :doc:`overview` section provides a high-level view of Python packaging | ||||||
and its use when preparing and distributing projects. | ||||||
This section helps you build understanding about selecting the tools and | ||||||
processes that are most suitable for your use case. | ||||||
This section helps you become familiar with available tools and | ||||||
processes. | ||||||
It includes what packaging is, the problems that it solves, and | ||||||
key considerations. | ||||||
|
||||||
To get an overview of the workflow used to publish your code, see | ||||||
:doc:`packaging flow <flow>`. | ||||||
|
||||||
Tutorials | ||||||
========= | ||||||
|
||||||
Tutorials are the best place to start for anyone new to installing or creating Python Packages. | ||||||
Tutorials walk through the steps needed to complete a project for the first time. | ||||||
Tutorials aim to help you succeed and provide a starting point for future | ||||||
exploration. | ||||||
The :doc:`tutorials/index` section includes: | ||||||
|
||||||
* A :doc:`tutorial on installing packages <tutorials/installing-packages>` | ||||||
|
@@ -65,29 +54,35 @@ The :doc:`tutorials/index` section includes: | |||||
* A :doc:`tutorial on packaging and distributing <tutorials/packaging-projects>` | ||||||
your project | ||||||
|
||||||
Guides | ||||||
====== | ||||||
How-to Guides | ||||||
============= | ||||||
|
||||||
Guides provide steps to perform a specific task. Guides are more focused on | ||||||
users who are already familiar with Python packaging and are looking for | ||||||
specific information. | ||||||
How-to Guides provide step-by-step instructions to perform a specific task. | ||||||
These guides are written for users who are already familiar with Python packaging. | ||||||
|
||||||
The :doc:`guides/index` section provides "how to" instructions in three major | ||||||
areas: package installation; building and distributing packages; miscellaneous | ||||||
topics. | ||||||
The :doc:`guides/index` section is organized in the following areas: | ||||||
|
||||||
Explanations and Discussions | ||||||
============================ | ||||||
* package installation | ||||||
* building and distributing packages | ||||||
* miscellaneous topics | ||||||
|
||||||
The :doc:`discussions/index` section for in-depth explanations and discussion | ||||||
about topics, such as: | ||||||
Explanations | ||||||
============ | ||||||
|
||||||
* :doc:`discussions/deploying-python-applications` | ||||||
* :doc:`discussions/pip-vs-easy-install` | ||||||
The :doc:`Explanations and Discussions <discussions/index>` section presents | ||||||
in-depth explanations and discussion about a packaging topic. These documents | ||||||
explain the rationale or "why" something is done. | ||||||
|
||||||
Specifications | ||||||
============== | ||||||
|
||||||
The :doc:`specifications/index` section documents the packaging interoperability specifications. | ||||||
|
||||||
Reference | ||||||
========= | ||||||
|
||||||
* The :doc:`specifications/index` section for packaging interoperability specifications. | ||||||
The :doc:`references/index` section describes projects and gives informative information. | ||||||
These resources typically answer "What is..." questions. The section includes: | ||||||
|
||||||
* The list of :doc:`other projects <key_projects>` maintained by members of the Python Packaging Authority. | ||||||
* The :doc:`glossary` for definitions of terms used in Python packaging. |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
Overview | ||
======== | ||
|
||
This section provides a high-level view of Python packaging, its use when | ||
preparing and distributing projects, and related workflows. | ||
|
||
.. toctree:: | ||
:titlesonly: | ||
|
||
../overview | ||
../flow |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
Reference | ||
========= | ||
|
||
**Reference** documents define terms and describe information about Python Packaging. | ||
|
||
These documents answer "What is ..." questions for users. | ||
If you're looking for a deeper explanation or discussion about something, | ||
see :doc:`/discussions/index`. | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
../key_projects | ||
../glossary | ||
../news |
This file contains 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be changed? We could update just the ToC entry text instead.