Skip to content

Commit 5780e97

Browse files
authored
Merge pull request #1368 from pradyunsg/page-titles-and-hierarchy
Improve sidebar presentation by tweaking titles and adding "section" pages for `guides/`
2 parents 2ff089b + 7773243 commit 5780e97

File tree

6 files changed

+46
-38
lines changed

6 files changed

+46
-38
lines changed

source/guides/index.rst

Lines changed: 4 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -6,40 +6,10 @@ already familiar with the basics of Python packaging. If you're looking for an
66
introduction to packaging, see :doc:`/tutorials/index`.
77

88
.. toctree::
9-
:maxdepth: 1
10-
:caption: Installing Packages:
11-
12-
installing-using-pip-and-virtual-environments
13-
installing-using-virtualenv
14-
installing-stand-alone-command-line-tools
15-
installing-using-linux-tools
16-
installing-scientific-packages
17-
18-
.. toctree::
19-
:maxdepth: 1
20-
:caption: Building and Publishing Projects:
21-
22-
distributing-packages-using-setuptools
23-
using-manifest-in
24-
single-sourcing-package-version
25-
dropping-older-python-versions
26-
packaging-binary-extensions
27-
packaging-namespace-packages
28-
creating-and-discovering-plugins
29-
using-testpypi
30-
making-a-pypi-friendly-readme
31-
publishing-package-distribution-releases-using-github-actions-ci-cd-workflows
32-
33-
.. toctree::
34-
:maxdepth: 1
35-
:caption: Hosting
36-
37-
index-mirrors-and-caches
38-
hosting-your-own-index
39-
40-
.. toctree::
41-
:maxdepth: 1
42-
:caption: Miscellaneous:
9+
:titlesonly:
4310

11+
section-install
12+
section-build-and-publish
13+
section-hosting
4414
tool-recommendations
4515
analyzing-pypi-package-downloads
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
=======================
2+
Building and Publishing
3+
=======================
4+
5+
.. toctree::
6+
:titlesonly:
7+
8+
distributing-packages-using-setuptools
9+
using-manifest-in
10+
single-sourcing-package-version
11+
dropping-older-python-versions
12+
packaging-binary-extensions
13+
packaging-namespace-packages
14+
creating-and-discovering-plugins
15+
using-testpypi
16+
making-a-pypi-friendly-readme
17+
publishing-package-distribution-releases-using-github-actions-ci-cd-workflows

source/guides/section-hosting.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
=======
2+
Hosting
3+
=======
4+
5+
.. toctree::
6+
:titlesonly:
7+
8+
index-mirrors-and-caches
9+
hosting-your-own-index

source/guides/section-install.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
============
2+
Installation
3+
============
4+
5+
.. toctree::
6+
:titlesonly:
7+
8+
installing-using-pip-and-virtual-environments
9+
installing-using-virtualenv
10+
installing-stand-alone-command-line-tools
11+
installing-using-linux-tools
12+
installing-scientific-packages

source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Overview and Flow
4141
continuous improvement are key to success. The overview and flow sections
4242
provide a starting point for understanding the Python packaging ecosystem.
4343

44-
The :doc:`Overview of Python Packaging <overview>` explains Python packaging
44+
The :doc:`overview` explains Python packaging
4545
and its use when preparing and distributing projects.
4646
This section helps you build understanding about selecting the tools and
4747
processes that are most suitable for your use case.

source/overview.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
===================================
2-
An Overview of Packaging for Python
3-
===================================
1+
============================
2+
Overview of Python Packaging
3+
============================
44

55
.. Editors, see notes at the bottom of the document for maintenance info.
66

0 commit comments

Comments
 (0)