ipypublish.sphinx.create_setup module

ipypublish.sphinx.create_setup.make_conf(overwrite=False, **kwargs)[source]

create the contents of a sphinx config.py with default values compliant with ipypublish.

Parameters
  • overwrite (bool) – if True, default arguments are overwritten by key-word arguments

  • kwargs – key-word arguments are included as <key> = <val> note docstring is a special key, inserted at the top of the file

Returns

conf_content

Return type

str

ipypublish.sphinx.create_setup.make_index(toc_files, toc_depth=3, toc_title='Table of Contents', toc_numbered=True, toc_glob=False, header=None, prolog=None, epilog=None)[source]

make an index file, containing a toc tree

Parameters
  • toc_files (list[str]) – list of file paths (relative to the index) to be included in the toc tree

  • toc_depth=3 (int) – depth of toc tree

  • toc_title (str) – title of toc tree

  • toc_numbered=True (bool) – number sections and figures, tables, etc

  • header (None or str) –

  • prolog (None or str) –

  • epilog (None or str) –

Returns

index_content

Return type

str