5.1.1.6. default

The default provides a standard style contained in sphinx.

../../../_images/default3.png

Figure: Theme ‘default’

configuration

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

setupddocx/configurations/sphinx/default

file

remark

docsrc/conf.py

adds configuration variables

docsrc/index.rst

adaptation of totree

docsrc/index_application.rst

adaptation of totree

docsrc/index_documentation.rst

adaptation of totree

docsrc/index_starthere.rst

adaptation of totree

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/default/ \
      --indexsrc=docsrc/index.rst \
      --docname setupdocx-default \
   install_docx \
      --dist-dir doc \
      --docname=setupdocx-default

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