5.1.2.1. Alabaster - alabaster

The alabaster provides a standard style contained in sphinx.

../../../_images/alabaster1.png

Figure: Theme ‘alabaster’

configuration

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

setupddocx/configurations/sphinx/alabaster

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  \
   build_docx \
      --conf-dir=setupdocx/configurations/sphinx/alabaster/ \
   install_docx \
      --dist-dir doc \
      --docname=alabaster

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

The same call with detailed command line parameters:

python setup.py  \
   build_docx \
      --doctype=html \
      --docname=alabaster \
      --conf-dir=setupdocx/confonfigurations/sphinx/alabaster/
   install_docx \
      --dist-dir doc \
      --docname=alabaster

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