Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add documentation for using coverpage #65

Merged
merged 4 commits into from
Jun 3, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions doc/source/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -149,3 +149,36 @@ variable:
"show_icons": False,
...
}

PDF coverpage
-------------

If you want to use a customized coverpage for the PDF,
add the preamble of the coverpage using ``latex elements``.
For using the Ansys coverpage, you can set LaTeX elements as:

.. code-block:: python

latex_elements = {
"preamble": ansys_sphinx_theme.latex.generate_preamble(
<title_of_coverpage>,
<watermark_for_titlepage>,
<date_to_be_printed>,)
}

The default date will be current date and watermark will be
the Ansys watermark.
To use the Ansys' logo and watermark in the LaTeX coverpage, you should import it and
add it in ``latex_additional_files``.

.. code-block:: python

from ansys_sphinx_theme import (
ansys_logo_white,
ansys_logo_white_cropped,
watermark,
)
.. code-block:: python

latex_additional_files = [
watermark, ansys_logo_white, ansys_logo_white_cropped]