5.1.1.7. sphinxdoc

The sphinxdoc provides a standard style contained in sphinx.

Figure: Theme ‘sphinxdoc’

configuration

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

setupddocx/configurations/sphinx/sphinxdoc

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

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