5.1.4.1. Read The Docs - sphinx_rtd_theme

The sphinx_rtd_theme provides a local them for ReadTheDocs style.

../../../_images/sphinx_rtd_theme1.png

Figure: Theme ‘sphinx_rtd_theme’

configuration

The current example implementation contains the files within the default path:

setupddocx/configurations/sphinx/sphinx_rtd_theme

file

remark

docsrc/conf.py

adds configuration variables

docsrc/_static/custom.css

sets some custom colors and sizes

docsrc/_static/favicon.ico

provides a demo favicon, requires ICO

docsrc/_static/logo.png

provides a demo logo, requires PNG

call

The call creates a html document within the local directory doc

python setup.py  -q  \
   build_docx  \
      --apiref  \
      --conf-dir setupdocx/configurations/sphinx_rtd_theme/ \
      --indexsrc=docsrc/index_rtd.rst \
      --docname setupdocx-rtd \
   install_docx \
      --dist-dir doc \
      --docname=setupdocx-rtd

# cut-and-paste for execution
# for readability split acros multiple lines