Add instructions to install pipx

- Refactor locations of includes so that Volto aligns with Documentation
plone · Nov 21, 2024 · 7e50196 · 7e50196
1 parent 0614520
commit 7e50196
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 32 deletions.
diff --git a/docs/_inc/_install-pipx.md b/docs/_inc/_install-pipx.md
@@ -0,0 +1,12 @@
+Install {term}`pipx` for your active Python, and ensure it is on your `$PATH`.
+Carefully read the console output for further instructions, if needed.
+
+```shell
+python3 -m pip install pipx
+pipx ensurepath
+```
+
+```{seealso}
+-   [Install `pipx` as a Standalone Tool](https://realpython.com/python-pipx/#install-pipx-as-a-standalone-tool)
+-   [Configure `pipx` Before the First Run](https://realpython.com/python-pipx/#configure-pipx-before-the-first-run)
+```
diff --git a/docs/conf.py b/docs/conf.py
@@ -148,12 +148,7 @@
     "plone.restapi/performance",
     "plone.restapi/src",
     "plone.restapi/var",
-    "volto/contributing/branch-policy.md",
-    "volto/contributing/install-docker.md",
-    "volto/contributing/install-git.md",
-    "volto/contributing/install-make.md",
-    "volto/contributing/install-nodejs.md",
-    "volto/contributing/install-operating-system.md",
+    "volto/_inc/*",
 ]
 
 suppress_warnings = [
@@ -442,8 +437,6 @@ def source_replace(app, docname, source):
 source_replacements = {
     "{PLONE_BACKEND_MINOR_VERSION}": "6.0",
     "{PLONE_BACKEND_PATCH_VERSION}": "6.0.13",
-    # "{SUPPORTED_PYTHON_VERSIONS_PLONE60}": "3.8, 3.9, 3.10, 3.11, or 3.12",
-    # "{SUPPORTED_PYTHON_VERSIONS_PLONE61}": "3.10, 3.11, or 3.12",
 }
 
 # Finally, configure app attributes.

diff --git a/docs/contributing/core/index.md b/docs/contributing/core/index.md
@@ -37,7 +37,7 @@ Before you contribute to Plone core, check the [version support policy](https://
 It is beyond the scope of this documentation to provide installation instructions for all prerequisites for your operating system.
 However, the following links and sections below may be helpful.
 
-```{include} ../../volto/contributing/install-operating-system.md
+```{include} ../../volto/_inc/_install-operating-system.md
 ```
 
 -   Python {{SUPPORTED_PYTHON_VERSIONS_PLONE61}}
@@ -55,13 +55,13 @@ Plone requires Python version {{SUPPORTED_PYTHON_VERSIONS_PLONE61}}.
 
 ### Make
 
-```{include} ../../volto/contributing/install-make.md
+```{include} ../../volto/_inc/_install-make.md
 ```
 
 
 ### Git
 
-```{include} ../../volto/contributing/install-git.md
+```{include} ../../volto/_inc/_install-git.md
 ```
 
 ### C compiler

diff --git a/docs/contributing/documentation/setup-build.md b/docs/contributing/documentation/setup-build.md
@@ -20,7 +20,7 @@ This document covers how to set up and build the Plone Documentation and check i
 
 Installation of Plone 6 Documentation includes prerequisites and the repository itself.
 
-```{include} ../../volto/contributing/install-operating-system.md
+```{include} ../../volto/_inc/_install-operating-system.md
 ```
 -   {ref}`setup-build-installation-python-label` {{SUPPORTED_PYTHON_VERSIONS_PLONE61}}
 -   {ref}`setup-build-installation-gnu-make-label`
@@ -38,7 +38,7 @@ Installation of Plone 6 Documentation includes prerequisites and the repository
 
 ### GNU make
 
-```{include} ../../volto/contributing/install-make.md
+```{include} ../../volto/_inc/_install-make.md
 ```
 
 

diff --git a/docs/install/create-project-cookieplone.md b/docs/install/create-project-cookieplone.md
@@ -45,7 +45,7 @@ Plone 6 has both hardware requirements and software prerequisites.
 
 ### Prerequisites for installation
 
-```{include} ../volto/contributing/install-operating-system.md
+```{include} ../volto/_inc/_install-operating-system.md
 ```
 
 -   Python {{SUPPORTED_PYTHON_VERSIONS_PLONE61}}
@@ -64,22 +64,19 @@ Plone 6 has both hardware requirements and software prerequisites.
 
 #### pipx
 
-Install {term}`pipx`.
-
-```shell
-pip install pipx
+```{include} /_inc/_install-pipx.md
 ```
 
 
 #### nvm
 
-```{include} ../volto/contributing/install-nvm.md
+```{include} ../volto/_inc/_install-nvm.md
 ```
 
 
 #### Node.js
 
-```{include} ../volto/contributing/install-nodejs.md
+```{include} ../volto/_inc/_install-nodejs.md
 ```
 
 3.  Enable {term}`corepack` so that Node.js will install {term}`pnpm` as a package manager.
@@ -91,13 +88,13 @@ pip install pipx
 
 #### Make
 
-```{include} ../volto/contributing/install-make.md
+```{include} ../volto/_inc/_install-make.md
 ```
 
 
 #### Git
 
-```{include} ../volto/contributing/install-git.md
+```{include} ../volto/_inc/_install-git.md
 ```
 
 

diff --git a/docs/install/create-project.md b/docs/install/create-project.md
@@ -42,7 +42,7 @@ Plone 6.0 has both hardware requirements and software prerequisites.
 
 ### Prerequisites for installation
 
-```{include} ../volto/contributing/install-operating-system.md
+```{include} ../volto/_inc/_install-operating-system.md
 ```
 
 -   Python {{SUPPORTED_PYTHON_VERSIONS_PLONE60}}
@@ -68,26 +68,23 @@ Plone 6.0 has both hardware requirements and software prerequisites.
 
 #### pipx
 
-Install {term}`pipx`.
-
-```shell
-pip install pipx
+```{include} /_inc/_install-pipx.md
 ```
 
 
 (install-prerequisites-nvm-label)=
 
 #### nvm
 
-```{include} ../volto/contributing/install-nvm.md
+```{include} ../volto/_inc/_install-nvm.md
 ```
 
 
 (install-prerequisites-nodejs-label)=
 
 #### Node.js
 
-```{include} ../volto/contributing/install-nodejs.md
+```{include} ../volto/_inc/_install-nodejs.md
 ```
 
 
@@ -137,23 +134,23 @@ Now the instructions to install Yarn should work.
 
 #### Make
 
-```{include} ../volto/contributing/install-make.md
+```{include} ../volto/_inc/_install-make.md
 ```
 
 
 (install-prerequisites-docker-label)=
 
 #### Docker
 
-```{include} ../volto/contributing/install-docker.md
+```{include} ../volto/_inc/_install-docker.md
 ```
 
 
 (install-prerequisites-git-label)=
 
 #### Git
 
-```{include} ../volto/contributing/install-git.md
+```{include} ../volto/_inc/_install-git.md
 ```