Install Sphinx on Mac OS X

I installed Sphinx in the environment of Mac OS X 10.8.5 + Python 2.7.5. You must be connected to the internet.

First, download and install ez_setup.py. Because of Mac OS X, the get command is curl instead of wget.

$ curl https://bitbucket.org/pypa/setuptools/raw/bootstrap/ez_setup.py -o ez_setup.py
$ python ez_setup.py

If the installation fails, try running it with administrator privileges.

$ sudo python ez_setup.py

Install Sphinx with the installed easy_install. This time 1.1.3 was selected. (The latest is 1.2.)

$ easy_install sphinx
Searching for sphinx
Best match: Sphinx 1.1.3
...

Create a project directory (here "sphinx") and move the current.

$ mkdir sphinx
$ cd sphinx/

Generate a Sphinx project with sphinx-quickstart. Since this is a "trial", I answered the questions after executing sphinx-quickstart with almost the initial values (press the [Enter] key).

$ sphinx-quickstart
$ ls
Makefile build/    make.bat source/

"Index.rst" in the source directory is the reStructuredText file.

$ ls source/
_static/    _templates/ conf.py    index.rst

Create HTML from a file in the source directory.

$ make html
$ ls build/html/
_sources/       genindex.html  objects.inv    searchindex.js
_static/        index.html     search.html

Start a WWW browser (Safari in this case) and check the created HTML.

$ open /Applications/Safari.app build/html/index.html

Recommended Posts

Install Sphinx on Mac OS X
Install mitmproxy on Mac OS X
Install pgmagick on Mac OS X 10.9
Memo on Mac OS X
Very easy to install SciPy on Mac OS X
Install Scipy on Mac OS Sierra
Install PyQt5 with homebrew on Mac OS X Marvericks (10.9.2)
How to install Theano on Mac OS X with homebrew
Installed aws-cli On Mac OS X Lion
Run NASA CEA on Mac OS X
Install Tensorflow on Mac
Install pyenv on mac
Install Ansible on Mac
Install Python on Mac
Install Python 3 on Mac
Install Python 3.4 on Mac
Install Caffe on Mac
Install mecab on mac
Install mecab-python on Mac
Install lp_solve on Mac OS X and call it with python.
How to install Theano on Mac OS X 10.10 (using pyenv, anaconda)
Run Zookeeper x python (kazoo) on Mac OS X
Shpinx (Python documentation builder) on Mac OS X
Install pygame on python3.4 on mac
Install tomcat 9 on Cent OS 8
Install module on Anaconda (Mac)
Install OpenPose on mac (Catalina)
Install numba on your Mac
Install pandas 0.14 on python3.4 [on Mac]
Install Django on your Mac
Install pillow on Mac OSX 10.9
[Mac] Tips: Install pyquery on Mac [pyquery]
Preparing to use aws cli on Mac OS X
Building an environment for "Tello_Video" on Mac OS X
How to install caffe on OS X with macports
Try using E-Cell 4 on Windows 7 or Mac OS X
Build a Python development environment on Mac OS X
mac OS X 10.15.x pyenv Python If you can't install
Install Python 3.8 on Ubuntu 18.04 (OS standard)
Install anaconda on Mac → Add Library
How to install mysql-connector-python on mac
Using NAOqi 2.4.2 Python SDK on Mac OS X El Capitan
Install Adopt OpenJDK 11 on Cent OS 8
Steps to install matplotlib on Mac
Installation of scikit-learn (Mac OS X)
Install Python 3.7 Anaconda on MAC, but Python 2
Install python3 on Mac (El Capitan)
How to install OpenCV on Mac
Install VirtualBox on CentOS 7 on VirtualBox (mac + vagrant)
Install Python 3.9 on Ubuntu 20.04 (OS standard?)
Install Python 2.7 on Ubuntu 20.04 (OS standard?)
Steps to install python3 on mac
Get started with the Python framework Django on Mac OS X
Continuation ・ Notes on preparing the Python development environment on Mac OS X
Quickly install OpenCV 2.4 (+ python) on OS X and try the sample
Mac OS X Mavericks 10.9.5 Development environment construction
How to install drobertadams / toggl-cli on Mac
How to erase Python 2.x on Mac.
Install 64-bit OS (bate) on Raspberry Pi
Install docker-compose on 64-bit Raspberry Pi OS
GeoDjango + SQLite environment construction on OS X