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

Restructure table of contents, section indices, and landing page #1409

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions source/contribute.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. |PyPUG| replace:: Python Packaging User Guide

************************
Contribute to this guide
Copy link
Member

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.

************************
************
Contributing
************
Comment on lines +3 to +5
Copy link
Contributor

Choose a reason for hiding this comment

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

I agree with @webknjaz on that.

Suggested change
************
Contributing
************
************************
Contribute to this guide
************************


The |PyPUG| welcomes contributors! There are lots of ways to help out,
including:
Expand Down
6 changes: 3 additions & 3 deletions source/discussions/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Discussions
###########
Explanations
============

**Discussions** are focused on providing comprehensive information about a
**Explanations and Discussions** focus on providing comprehensive information about a
specific topic. If you're just trying to get stuff done, see
:doc:`/guides/index`.

Expand Down
7 changes: 4 additions & 3 deletions source/guides/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Guides
######
How-to Guides
=============

**Guides** are focused on accomplishing a specific task and assume that you are
**How-to Guides** are focused on accomplishing a specific task and assume that you are
already familiar with the basics of Python packaging. If you're looking for an
introduction to packaging, see :doc:`/tutorials/index`.

Expand All @@ -13,3 +13,4 @@ introduction to packaging, see :doc:`/tutorials/index`.
section-hosting
tool-recommendations
analyzing-pypi-package-downloads
../support
75 changes: 35 additions & 40 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
contribute
Contributing <contribute>

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>`
Expand All @@ -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.
11 changes: 11 additions & 0 deletions source/overview/index.rst
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
15 changes: 15 additions & 0 deletions source/references/index.rst
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
5 changes: 2 additions & 3 deletions source/tutorials/index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
Tutorials
=========

**Tutorials** are opinionated step-by-step guides to help you get familiar
with packaging concepts. For more detailed information on specific packaging
topics, see :doc:`/guides/index`.
**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 and avoid presenting you with early decision-making.

.. toctree::
:maxdepth: 1
Expand Down
Loading