CODEWITHSUNDEEP
bashinstallationrootlocalpython-sphinx
pmjn6
pmjn6

Reputation: 307

Sphinx-quickstart doesn't work

I am trying to install sphinx on a remote machine.

Since I don't have an access to the root, I did this:

$bash

$mkdir -p ~/local/lib/python2.7/site-packages

$export PYTHONPATH=$PYTHONPATH:~/local/lib/python2.7/site-packages

$export PATH=$PATH::~/local/lib/python2.7/site-packages

$easy_install -U --prefix=$HOME/local Sphinx

But apparently, $easy_install doesn't build sphinx-quickstart; when I type 

$sphinx-quickstart

I get the following message:

bash: sphinx-quickstart: command not found

I tried 

find $HOME -name sphinx-quickstart

and no result was found. However, I can import sphinx inside python:

$python

And then

>>import sphinx

works. Any idea why sphinx-quickstart doesn't work?

Upvotes: 9

Views: 15030

Answers (6)

Prem Gandhi
Prem Gandhi

Reputation: 1

I found that running python "path to sphinx-quickstart-script.py" works. I was using micromamba when I did then and so I had to activate my environment first and then run this in my VS code terminal.

Upvotes: 0

Vaibhav Mishra
Vaibhav Mishra

Reputation: 445

Have added an answer for installation on macOS using brew here

For new users, installing with brew gives the following caveats:

==> sphinx-doc
sphinx-doc is keg-only, which means it was not symlinked into /usr/local,
because this formula is mainly used internally by other formulae.
Users are advised to use `pip` to install sphinx-doc.

If you need to have sphinx-doc first in your PATH, run:
  echo 'export PATH="/usr/local/opt/sphinx-doc/bin:$PATH"' >> ~/.zshrc

Running the echo command:

echo 'export PATH="/usr/local/opt/sphinx-doc/bin:$PATH"' >> ~/.zshrc

should fix the issue.

Don't miss source-ing the .zshrc after the updating it:

source ~/.zshrc

Upvotes: 0

adam.hendry
adam.hendry

Reputation: 5645

Note, if you're in a virtual environment and using poetry to run

poetry run py -m sphinx.cmd.quickstart

where py is the python launcher for Windows.

Upvotes: 0

Gonzalo Garcia
Gonzalo Garcia

Reputation: 6632

In MacOS (Catalina) and zsh:

I installed sphinx with brew and had the same problem as you.

Solution: Installed it with conda as conda install sphinx and now it works for me

$ sphinx-quickstart
Welcome to the Sphinx 2.3.0 quickstart utility.

Installation Guide

Upvotes: 0

jdknight
jdknight

Reputation: 1839

An alternative way to invoke sphinx-quickstart is to explicitly load Sphinx's quickstart module. For Sphinx v1.7+:

python -m sphinx.cmd.quickstart

For older versions of Sphinx:

python -m sphinx.quickstart

For example:

$ /c/Python35/python -m sphinx.quickstart
Welcome to the Sphinx 1.6.2 quickstart utility.
...

Upvotes: 23

pmjn6
pmjn6

Reputation: 307

I found the solution in this webpage:

User (root/sudo free) installation of Python modules.

In section 3. Python 2.6+ he mentioned that the command line commands are in 

~/local/bin

Although I had put ~/local/lib/python2.7/siste-packages in the path, the ~/local/bin directory was not in the path. So all I did

$export PYTHONPATH=$PYTHONPATH:~/local/bin

and now it works.

I don't know why find $HOME -name sphinx-quickstart did not find sphinx-quickstart

Upvotes: 1

Related Questions