itbakery/install-sphinx.md

## install-sphinx.md

      
    Raw
  

              install-sphinx.md
            
          
    Install package

sudo pip3 install --upgrade pip
sudo pip3 install --upgrade sphinx
sudo pip3 install --upgrade pyyaml
sudo pip3 install --upgrade t3SphinxThemeRtd
sudo pip3 install --upgrade t3fieldlisttable
sudo pip3 install --upgrade t3tablerows
sudo pip3 install --upgrade t3targets
sudo pip3 install --upgrade sphinxcontrib-googlechart
sudo pip3 install --upgrade sphinxcontrib-googlemaps
sudo pip3 install --upgrade sphinxcontrib-httpdomain
sudo pip3 install --upgrade sphinxcontrib-slide
sudo pip3 install --upgrade sphinxcontrib.youtube
sudo pip3 install --upgrade sphinx_rtd_theme
sudo pip3 install --upgrade Pygments

Generate project

sphinx-quickstart  project
cd project
make html

Use extenstion

extensions = ['sphinxcontrib.youtube']
.. youtube:: http://www.youtube.com/watch?v=Ql9sn3aLLlI

.. youtube:: Ql9sn3aLLlI

use theme

import sphinx_rtd_theme
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
pygments_style = 'monokai'


Add custom theme support pygments style

Create source/_templates/layout.html tempate with the following content:

{# layout.html #}
{# Import the theme's layout. #}
{% extends "!layout.html" %}

{% set css_files = css_files + ['_static/pygments.css'] %}

Then your pygments_style variable in the conf.py will take effect.

https://help.farbox.com/pygments.html