diff options
author | Jamie Lemon <jamie.lemon@artifex.com> | 2022-10-24 16:08:32 +0100 |
---|---|---|
committer | Jamie Lemon <jamie.lemon@artifex.com> | 2022-10-25 12:50:55 +0100 |
commit | 0ec5e6cca5db2ee1a1e61ec3a8819eced69cc049 (patch) | |
tree | b00d53a260547c80b4c55f02d7baac7e42c20d05 /doc | |
parent | 6ad1e9459279276785aa6a230b5c683d4a5c029b (diff) | |
download | ghostpdl-0ec5e6cca5db2ee1a1e61ec3a8819eced69cc049.tar.gz |
Documentation updates.
- Adds -dNO_PDFMARK_OUTLINES switch
to high level devices (VectorDevices.rst).
- Updates PDF to be built from Latex.
- Updates HowToBuildTheDocs.txt with info
around the building the PDF with Latex.
- Fixes the rendering of the unicode >=
character for the Latex PDF output.
- Fixes some broken links in the
language bindings section.
- Fixes a syntax warning around the
layout of a header within the
color management section.
- Updates the Ghostscript.pdf to reflect changes
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Ghostscript.pdf | bin | 5683262 -> 4526055 bytes | |||
-rw-r--r-- | doc/HowToBuildTheDocs.txt | 23 | ||||
-rw-r--r-- | doc/src/GhostscriptColorManagement.rst | 3 | ||||
-rw-r--r-- | doc/src/LanguageBindingsCSharp.rst | 11 | ||||
-rw-r--r-- | doc/src/LanguageBindingsJava.rst | 2 | ||||
-rw-r--r-- | doc/src/LanguageBindingsPython.rst | 4 | ||||
-rw-r--r-- | doc/src/VectorDevices.rst | 2 | ||||
-rw-r--r-- | doc/src/conf.py | 8 |
8 files changed, 38 insertions, 15 deletions
diff --git a/doc/Ghostscript.pdf b/doc/Ghostscript.pdf Binary files differindex 41c45e718..ea8f9f4fa 100644 --- a/doc/Ghostscript.pdf +++ b/doc/Ghostscript.pdf diff --git a/doc/HowToBuildTheDocs.txt b/doc/HowToBuildTheDocs.txt index 26c89d239..950f9b55a 100644 --- a/doc/HowToBuildTheDocs.txt +++ b/doc/HowToBuildTheDocs.txt @@ -10,9 +10,7 @@ Installing Sphinx & dependencies 1. You should follow the instructions on the Sphinx website to install Sphinx on your system. -2. Ensure you have rst2pdf (https://pypi.org/project/rst2pdf/) installed: - - pip install rst2pdf +2. Ensure you have Latex (https://www.latex-project.org/get/) installed This ensures that you can build a PDF of the documentation. @@ -67,14 +65,27 @@ This then creates the HTML documentation within `doc/build` for your review, you Building PDF documentation -------------------------- -From the `doc` location run: +Ensure that `pdflatex` is on your PATH, test with: + +pdflatex --help + + +Then create the latex build from the `doc` location: + +sphinx-build -b latex src build/latex + + +Once done do: +cd build/latex +make -sphinx-build -b pdf src . +If there any warnings then hit return to pass through them to continue building ( also decide if you need to fix them or not ). -This will then generate a single PDF for all of the documentation within `doc`. +Now you should have Ghostscript.pdf ready within `build/latex`. +Move the Ghostscript.pdf file into the root of "doc" and replace the existing PDF as required. Updating the documentation diff --git a/doc/src/GhostscriptColorManagement.rst b/doc/src/GhostscriptColorManagement.rst index bbd4d885a..4e9b9edbd 100644 --- a/doc/src/GhostscriptColorManagement.rst +++ b/doc/src/GhostscriptColorManagement.rst @@ -837,8 +837,7 @@ the following: ``gsicc_link_cache_t* gsicc_cache_new(gs_memory_t *memory);`` Creator for the Link Cache. -``void gsicc_init_buffer(gsicc_bufferdesc_t *buffer_desc, unsigned char num_chan, unsigned char bytes_per_chan, bool has_alpha, bool alpha_first, -bool is_planar, int plane_stride, int row_stride, int num_rows, int pixels_per_row);`` +``void gsicc_init_buffer(gsicc_bufferdesc_t *buffer_desc, unsigned char num_chan, unsigned char bytes_per_chan, bool has_alpha, bool alpha_first, bool is_planar, int plane_stride, int row_stride, int num_rows, int pixels_per_row);`` This is used to initialize a ``gsicc_bufferdesc_t`` object. Two of these objects are used to describe the format of the source and destination buffers when transforming a buffer of color values. ``gsicc_link_t* gsicc_get_link(gs_imager_state * pis, gx_device *dev, gs_color_space *input_colorspace, gs_color_space *output_colorspace, gsicc_rendering_param_t *rendering_params, gs_memory_t *memory);`` diff --git a/doc/src/LanguageBindingsCSharp.rst b/doc/src/LanguageBindingsCSharp.rst index 1569c2dce..58ca6b00f 100644 --- a/doc/src/LanguageBindingsCSharp.rst +++ b/doc/src/LanguageBindingsCSharp.rst @@ -25,10 +25,9 @@ Within this project the following namespaces and corresponding C# files are of r Platform & setup ======================= - Ghostscript should be built as a shared library for your platform. -See :ref:`Building Ghostscript<Building Ghostscript>`. +See :ref:`Building Ghostscript<Make.htm>`. GhostAPI @@ -456,6 +455,7 @@ There is a 64 KB length limit on any buffer submitted to a ``gsapi_run_*`` funct public static extern int gsapi_run_string_begin(IntPtr instance, int usererr, ref int exitcode); + ``gsapi_run_string_continue`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -479,6 +479,7 @@ There is a 64 KB length limit on any buffer submitted to a ``gsapi_run_*`` funct uint length, int usererr, ref int exitcode); + ``gsapi_run_string`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -488,6 +489,7 @@ There is a 64 KB length limit on any buffer submitted to a ``gsapi_run_*`` funct IntPtr command, int usererr, ref int exitcode); + ``gsapi_run_string_end`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -676,6 +678,7 @@ Callback and Callout prototypes public delegate int gs_stdio_handler(IntPtr caller_handle, IntPtr buffer, int len); + ``gsPollHandler`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -1416,7 +1419,7 @@ Launches a thread rendering a set of pages with the :ref:`display device<Devices ``GetStatus`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Returns the current :ref:`status<_GhostNET_Status>` of Ghostscript. +Returns the current :ref:`status<GhostNET_Status>` of Ghostscript. .. code-block:: csharp @@ -2082,7 +2085,7 @@ Launches a thread rendering a set of pages with the :ref:`display device<Devices ``GetStatus`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Returns the current :ref:`status<_GhostNET_Status>` of Ghostscript. +Returns the current :ref:`status<GhostNET_Status>` of Ghostscript. .. code-block:: csharp diff --git a/doc/src/LanguageBindingsJava.rst b/doc/src/LanguageBindingsJava.rst index d851cc7ee..85e0c329f 100644 --- a/doc/src/LanguageBindingsJava.rst +++ b/doc/src/LanguageBindingsJava.rst @@ -29,7 +29,7 @@ Platform & setup Ghostscript should be built as a shared library for your platform. -See :ref:`Building Ghostscript<Building Ghostscript>`. +See :ref:`Building Ghostscript<Make.htm>`. diff --git a/doc/src/LanguageBindingsPython.rst b/doc/src/LanguageBindingsPython.rst index 8108419eb..9c1361b7e 100644 --- a/doc/src/LanguageBindingsPython.rst +++ b/doc/src/LanguageBindingsPython.rst @@ -23,7 +23,7 @@ Platform & setup Ghostscript should be built as a shared library for your platform. -See :ref:`Building Ghostscript<Building Ghostscript>`. +See :ref:`Building Ghostscript<Make.htm>`. @@ -242,7 +242,7 @@ Set the callback function for polling. Your instance of Ghostscript. ``poll_fn`` - Will be called with ``caller_handle`` as passed to :ref:`gsapi_new_instance(python gsapi_new_instance)<>`. + Will be called with ``caller_handle`` as passed to :ref:`gsapi_new_instance<python gsapi_new_instance>`. **Sample code**: diff --git a/doc/src/VectorDevices.rst b/doc/src/VectorDevices.rst index daee5bc15..a998b3d47 100644 --- a/doc/src/VectorDevices.rst +++ b/doc/src/VectorDevices.rst @@ -974,6 +974,8 @@ PDF file output ``-dOmitXMPboolean`` Under some conditions the XMP ``/Metadata`` entry in the ``Catalog`` dictionary is optional and can be omitted. It is required when producing PDF/A output however. This control will allow the user to omit the ``/Metadata`` entry in the ``Catalog`` dictionary. If you try to set this control when writing PDF/A output, the device will give a warning and ignore this control. +``-dNO_PDFMARK_OUTLINES`` + When the input is a PDF file which has an ``/Outlines`` tree (called "Bookmarks" in Adobe Acrobat) these are normally turned into ``pdfmarks`` and sent to the ``pdfwrite`` device so that they are preserved in the output PDF file. However, if this control is set then the interpreter will ignore the Outlines in the input. The following options are useful for creating PDF 1.2 files: diff --git a/doc/src/conf.py b/doc/src/conf.py index 510a56907..23b6be5f4 100644 --- a/doc/src/conf.py +++ b/doc/src/conf.py @@ -187,7 +187,15 @@ htmlhelp_basename = "Ghostscript" # -- Options for LaTeX output --------------------------------------------- +# This ensures that the ≥ character (Unicode character ≥ = U+2265) will +# render correctly in the PDF latex_elements = { + "preamble" : r''' +\ifdefined\sphinxDUC + \sphinxDUC{2265}{\ensuremath{\ge}} +\fi +''', + # "fontpkg": r"\usepackage[sfdefault]{ClearSans} \usepackage[T1]{fontenc}" } # Grouping the document tree into LaTeX files. List of tuples |