Coding With Fun
Home Docker Django Node.js Articles Python pip guide FAQ Policy
 

How to install sphinx-pyproject via python pip




sphinx-pyproject - Move some of your Sphinx configuration into pyproject.toml, it belongs to Classifiers:

- Framework :: Sphinx
- Programming Language :: Python :: Implementation :: PyPy
- Topic :: Documentation
- Topic :: Documentation :: Sphinx
- Topic :: Software Development :: Documentation
- Typing :: Typed

When you know about this project and you want to new install sphinx-pyproject to support your project or you get trouble as ModuleNotFoundError: No module named "sphinx-pyproject" or ImportError: cannot import name "sphinx-pyproject" in your project, let follow this tutorial to install sphinx-pyproject



Installation:

Step 1: First, ensure you installed pip in your os, to check pip has been installed on your computer

In Windows (CMD):

py -m pip --version

In Unix/macOS:

python3 -m pip --version

Ensure pip, setuptools, and wheel are up to date:

In Windows (CMD):

py -m pip install --upgrade pip setuptools wheel

In Unix/macOS:

python3 -m pip install --upgrade pip setuptools wheel


Optional - If you want to install in virtual environment:

In Windows (CMD):

- Install virtualenv - if you installed it, please ignore

py -m pip install --user virtualenv

- Create a virtual environment

py -m venv test_sphinx-pyproject_env

- Active the virtual environment

test_sphinx-pyproject_env\Scripts\active

In Unix/macOS:

- Install virtualenv - if you installed it, please ignore

pip3 install virtualenv

- Create a virtual environment

python3 -m venv test_sphinx-pyproject_env

- Active the virtual environment

source test_sphinx-pyproject_env/bin/active


Step 2: OK, now, let flow below content to start the installation sphinx-pyproject

To install sphinx-pyproject on Windows(CMD):

py -m pip install sphinx-pyproject

To install sphinx-pyproject on Unix/macOs:

pip install sphinx-pyproject


Step 3: If you want to install a specific sphinx-pyproject version, add ==<sphinx-pyproject version> to the end command line

Example:

pip install sphinx-pyproject==0.1.0


Please see the version list below table:

VersionReleased dateCommand
sphinx-pyproject 0.1.02021-04-05T08:02:45Windows:

py -m pip install sphinx-pyproject==0.1.0

Unix/macOs:

pip install sphinx-pyproject==0.1.0


Step 4: Otherwise, you can install sphinx-pyproject from local archives:

Download the distribution file from sphinx_pyproject-0.1.0.tar.gz or the specific sphinx-pyproject version in the below list of distribution

After that, install by command:

On Windows(CMD):

py -m pip install <path_to_sphinx-pyproject_downloaded_file>

On Unix/macOs:

pip install <path_to_sphinx-pyproject_downloaded_file>


List distribution:


Project link:

- Homepage
- Documentation
- Issue Tracker
- Source Code