maketitle

Create a title slide for the presentation.

maketitle could be overwritten by the theme used for the prensentation

from beampy import *

# Remove quiet=True to get Beampy render outputs
doc = document(quiet=True)

with slide():
    maketitle('Beampy a tool to make simple presentation',
              author='H. Chauvet',
              subtitle='Written in Python',
              date='now')


display_matplotlib(gcs())
../_images/sphx_glr_plot_title_001.png

Module arguments

beampy.maketitle(*args, **kwargs)

Create title content for the presentation. The function could be overwritten by Beampy theme. Theme could add or change the arguments of maketitle() function. The default theme use the set of parameters described below. These arguments should not be modified by other themes.

Parameters:
  • titlein (str) – The title of the presentation.
  • author (str or list of str or None, optional) – The name of the author, or the list of author names (the default value is None).
  • subtitle (str or None, optional) – The subtitle for the presentation (the default value is None).
  • date (str or {'Today', 'today', 'now'} or None, optional) – The date for the presentation (the default value is None). If date is a str it will be displayed as the given str. If the date is either ‘Today’ or ‘today’ or ‘now’ it will replaced automatically by the current date.
  • title_width (int or float or str or None, optional) – The width of the titlein text (the default is value is None, which implies tilte_width = document._width * 0.75). If a title_width is given it is passed to the beampy.text() module to constrain the width of the titlein text.
  • vert_space (int or float or str or None, optional) – The vertical spacing of maketitle elements (the default value is None, which implies vert_space = document._height * 0.75). vert_space could take any values allowed by the positioning system of beampy (see x or y allowed values for beampy.base_module).

Gallery generated by Sphinx-Gallery