Skip to content

Latest commit

 

History

History
42 lines (35 loc) · 731 Bytes

Setup.md

File metadata and controls

42 lines (35 loc) · 731 Bytes

Sphinx Installation

Install Sphinx

pip install Sphinx

Install markdown support

pip install recommonmark

See more detail http://www.sphinx-doc.org/en/stable/markdown.html

Install readthedoc theme

pip install sphinx_rtd_theme

See more detail https://github.com/rtfd/sphinx_rtd_theme

Install plugins

pip install sphinxcontrib-newsfeed
pip install sphinxcontrib-spelling

Local setting

Install nginx and config like below. Set document root accordingly.

# nginx conf

server {
	listen 80;
	server_name docs.patric.local;
	root /p3_docs/docroot/_build/html;
}

Add record for docs.patric.local in /etc/hosts with sudo

127.0.0.1	localhost
127.0.0.1	docs.patric.local