summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJamie Lemon <jamie.lemon@artifex.com>2023-04-26 15:29:45 +0100
committerJamie Lemon <jamie.lemon@artifex.com>2023-04-26 15:29:45 +0100
commitcd5f0a99df59c9ebc0234237cfaf8036be583c40 (patch)
tree6136fb4090383321ec2438c5e92f96d317327843
parent30e1cb99874c46779de7dad8210520e09a78d42e (diff)
downloadghostpdl-gs10.01.1.tar.gz
Documentation updates - improved TOCgs10.01.1
- Adds GPDL to TOC and tweaks Home icon CSS. - A better TOC, updated copyright header. - Adds headers in Use.rst for basic use examples.
-rw-r--r--doc/src/API.rst2
-rw-r--r--doc/src/C-style.rst2
-rw-r--r--doc/src/Develop.rst2
-rw-r--r--doc/src/DeviceSubclassing.rst2
-rw-r--r--doc/src/Devices.rst2
-rw-r--r--doc/src/Drivers.rst2
-rw-r--r--doc/src/Fonts.rst2
-rw-r--r--doc/src/GPDL.rst2
-rw-r--r--doc/src/GhostscriptColorManagement.rst6
-rw-r--r--doc/src/Install.rst4
-rw-r--r--doc/src/Language.rst4
-rw-r--r--doc/src/LanguageBindings.rst2
-rw-r--r--doc/src/LanguageBindingsCSharp.rst2
-rw-r--r--doc/src/LanguageBindingsJava.rst2
-rw-r--r--doc/src/LanguageBindingsPython.rst2
-rw-r--r--doc/src/Lib.rst4
-rw-r--r--doc/src/Make.rst4
-rw-r--r--doc/src/News.rst2
-rw-r--r--doc/src/Ps-style.rst2
-rw-r--r--doc/src/Ps2epsi.rst2
-rw-r--r--doc/src/Psfiles.rst2
-rw-r--r--doc/src/Readme.rst8
-rw-r--r--doc/src/SampleDownscaleDevice.rst2
-rw-r--r--doc/src/SavedPages.rst2
-rw-r--r--doc/src/Source.rst2
-rw-r--r--doc/src/Unix-lpr.rst2
-rw-r--r--doc/src/UnsupportedDevices.rst4
-rw-r--r--doc/src/Use.rst39
-rw-r--r--doc/src/VectorDevices.rst2
-rw-r--r--doc/src/_static/custom.css4
-rw-r--r--doc/src/conf.py32
-rw-r--r--doc/src/footer.rst2
-rw-r--r--doc/src/header.rst3
-rw-r--r--doc/src/images/ghostscript-logo.pngbin0 -> 36365 bytes
-rw-r--r--doc/src/index.rst85
-rw-r--r--doc/src/thirdparty.rst7
-rw-r--r--doc/src/toc.rst1
37 files changed, 186 insertions, 63 deletions
diff --git a/doc/src/API.rst b/doc/src/API.rst
index f8a5e7bc6..606f2db9b 100644
--- a/doc/src/API.rst
+++ b/doc/src/API.rst
@@ -1,4 +1,4 @@
-.. Copyright (C) 2001-2022 Artifex Software, Inc.
+.. Copyright (C) 2001-2023 Artifex Software, Inc.
.. All Rights Reserved.
.. title:: API
diff --git a/doc/src/C-style.rst b/doc/src/C-style.rst
index 3b61c33b2..09ae64bf7 100644
--- a/doc/src/C-style.rst
+++ b/doc/src/C-style.rst
@@ -1,4 +1,4 @@
-.. Copyright (C) 2001-2022 Artifex Software, Inc.
+.. Copyright (C) 2001-2023 Artifex Software, Inc.
.. All Rights Reserved.
.. title:: Ghostscript C Coding Guidelines
diff --git a/doc/src/Develop.rst b/doc/src/Develop.rst
index fef760968..4f6c7fe81 100644
--- a/doc/src/Develop.rst
+++ b/doc/src/Develop.rst
@@ -1,4 +1,4 @@
-.. Copyright (C) 2001-2022 Artifex Software, Inc.
+.. Copyright (C) 2001-2023 Artifex Software, Inc.
.. All Rights Reserved.
.. title:: Information for Ghostscript Developers
diff --git a/doc/src/DeviceSubclassing.rst b/doc/src/DeviceSubclassing.rst
index 0f92a1f35..bf94d69a4 100644
--- a/doc/src/DeviceSubclassing.rst
+++ b/doc/src/DeviceSubclassing.rst
@@ -1,4 +1,4 @@
-.. Copyright (C) 2001-2022 Artifex Software, Inc.
+.. Copyright (C) 2001-2023 Artifex Software, Inc.
.. All Rights Reserved.
.. title:: Device Subclassing
diff --git a/doc/src/Devices.rst b/doc/src/Devices.rst
index ed9645e83..b1e6c1448 100644
--- a/doc/src/Devices.rst
+++ b/doc/src/Devices.rst
@@ -1,4 +1,4 @@
-.. Copyright (C) 2001-2022 Artifex Software, Inc.
+.. Copyright (C) 2001-2023 Artifex Software, Inc.
.. All Rights Reserved.
.. title:: Details of Ghostscript Output Devices
diff --git a/doc/src/Drivers.rst b/doc/src/Drivers.rst
index a47a7318c..405d7987e 100644
--- a/doc/src/Drivers.rst
+++ b/doc/src/Drivers.rst
@@ -1,4 +1,4 @@
-.. Copyright (C) 2001-2022 Artifex Software, Inc.
+.. Copyright (C) 2001-2023 Artifex Software, Inc.
.. All Rights Reserved.
.. title:: The Interface between Ghostscript and Device Drivers
diff --git a/doc/src/Fonts.rst b/doc/src/Fonts.rst
index 8a6258ada..96d59500e 100644
--- a/doc/src/Fonts.rst
+++ b/doc/src/Fonts.rst
@@ -1,4 +1,4 @@
-.. Copyright (C) 2001-2022 Artifex Software, Inc.
+.. Copyright (C) 2001-2023 Artifex Software, Inc.
.. All Rights Reserved.
.. title:: Fonts and Font Facilities Supplied with Ghostscript
diff --git a/doc/src/GPDL.rst b/doc/src/GPDL.rst
index b25fb6430..1cc332605 100644
--- a/doc/src/GPDL.rst
+++ b/doc/src/GPDL.rst
@@ -1,4 +1,4 @@
-.. Copyright (C) 2001-2022 Artifex Software, Inc.
+.. Copyright (C) 2001-2023 Artifex Software, Inc.
.. All Rights Reserved.
.. title:: The GhostPDL Interpreter Framework
diff --git a/doc/src/GhostscriptColorManagement.rst b/doc/src/GhostscriptColorManagement.rst
index ba65a120c..cce8545b3 100644
--- a/doc/src/GhostscriptColorManagement.rst
+++ b/doc/src/GhostscriptColorManagement.rst
@@ -1,4 +1,4 @@
-.. Copyright (C) 2001-2022 Artifex Software, Inc.
+.. Copyright (C) 2001-2023 Artifex Software, Inc.
.. All Rights Reserved.
.. title:: Ghostscript Color Management
@@ -20,9 +20,9 @@ Michael J. Vrhel, Ph.D.
Artifex Software
-1305 Grant Avenue, Suite 200
+39 Mesa Street, Suite 108A
-Novato, CA 94945, USA
+San Francisco, CA 94129, USA
Abstract
diff --git a/doc/src/Install.rst b/doc/src/Install.rst
index 2cfc40052..df624cf6f 100644
--- a/doc/src/Install.rst
+++ b/doc/src/Install.rst
@@ -1,4 +1,4 @@
-.. Copyright (C) 2001-2022 Artifex Software, Inc.
+.. Copyright (C) 2001-2023 Artifex Software, Inc.
.. All Rights Reserved.
.. title:: How to Install Ghostscript
@@ -10,7 +10,7 @@
.. _HowToInstallGhostscript:
-How to Install Ghostscript
+Installing
===================================
diff --git a/doc/src/Language.rst b/doc/src/Language.rst
index d54f3c3ef..a2de6f9e2 100644
--- a/doc/src/Language.rst
+++ b/doc/src/Language.rst
@@ -1,4 +1,4 @@
-.. Copyright (C) 2001-2022 Artifex Software, Inc.
+.. Copyright (C) 2001-2023 Artifex Software, Inc.
.. All Rights Reserved.
.. title:: Ghostscript and the PostScript Language
@@ -10,7 +10,7 @@
.. _Language:
-Ghostscript and the PostScript Language
+PostScript Language
===========================================
diff --git a/doc/src/LanguageBindings.rst b/doc/src/LanguageBindings.rst
index ef4998513..2afbef347 100644
--- a/doc/src/LanguageBindings.rst
+++ b/doc/src/LanguageBindings.rst
@@ -1,4 +1,4 @@
-.. Copyright (C) 2001-2022 Artifex Software, Inc.
+.. Copyright (C) 2001-2023 Artifex Software, Inc.
.. All Rights Reserved.
.. title:: Language Bindings
diff --git a/doc/src/LanguageBindingsCSharp.rst b/doc/src/LanguageBindingsCSharp.rst
index ab113614c..34932da23 100644
--- a/doc/src/LanguageBindingsCSharp.rst
+++ b/doc/src/LanguageBindingsCSharp.rst
@@ -1,4 +1,4 @@
-.. Copyright (C) 2001-2022 Artifex Software, Inc.
+.. Copyright (C) 2001-2023 Artifex Software, Inc.
.. All Rights Reserved.
.. title:: C#
diff --git a/doc/src/LanguageBindingsJava.rst b/doc/src/LanguageBindingsJava.rst
index e53ca1a6d..e0e059388 100644
--- a/doc/src/LanguageBindingsJava.rst
+++ b/doc/src/LanguageBindingsJava.rst
@@ -1,4 +1,4 @@
-.. Copyright (C) 2001-2022 Artifex Software, Inc.
+.. Copyright (C) 2001-2023 Artifex Software, Inc.
.. All Rights Reserved.
.. title:: Java
diff --git a/doc/src/LanguageBindingsPython.rst b/doc/src/LanguageBindingsPython.rst
index c62e141c1..4f64b677a 100644
--- a/doc/src/LanguageBindingsPython.rst
+++ b/doc/src/LanguageBindingsPython.rst
@@ -1,4 +1,4 @@
-.. Copyright (C) 2001-2022 Artifex Software, Inc.
+.. Copyright (C) 2001-2023 Artifex Software, Inc.
.. All Rights Reserved.
.. title:: Python
diff --git a/doc/src/Lib.rst b/doc/src/Lib.rst
index 197b3d855..708feab5a 100644
--- a/doc/src/Lib.rst
+++ b/doc/src/Lib.rst
@@ -1,4 +1,4 @@
-.. Copyright (C) 2001-2022 Artifex Software, Inc.
+.. Copyright (C) 2001-2023 Artifex Software, Inc.
.. All Rights Reserved.
.. title:: The Ghostscript Library
@@ -10,7 +10,7 @@
.. _Lib.htm:
-The Ghostscript Library
+The Core Library
===================================
diff --git a/doc/src/Make.rst b/doc/src/Make.rst
index 1a6ad96c5..3dca37bfd 100644
--- a/doc/src/Make.rst
+++ b/doc/src/Make.rst
@@ -1,4 +1,4 @@
-.. Copyright (C) 2001-2022 Artifex Software, Inc.
+.. Copyright (C) 2001-2023 Artifex Software, Inc.
.. All Rights Reserved.
.. title:: How to Build Ghostscript from Source Code
@@ -7,7 +7,7 @@
.. _Make.htm:
-How to Build Ghostscript from Source Code
+Building from Source
=========================================
diff --git a/doc/src/News.rst b/doc/src/News.rst
index badf004e0..96ac0eb4a 100644
--- a/doc/src/News.rst
+++ b/doc/src/News.rst
@@ -1,4 +1,4 @@
-.. Copyright (C) 2001-2022 Artifex Software, Inc.
+.. Copyright (C) 2001-2023 Artifex Software, Inc.
.. All Rights Reserved.
.. title:: News
diff --git a/doc/src/Ps-style.rst b/doc/src/Ps-style.rst
index 4d4b0fe22..cb419874a 100644
--- a/doc/src/Ps-style.rst
+++ b/doc/src/Ps-style.rst
@@ -1,4 +1,4 @@
-.. Copyright (C) 2001-2022 Artifex Software, Inc.
+.. Copyright (C) 2001-2023 Artifex Software, Inc.
.. All Rights Reserved.
.. title:: Ghostscript PostScript Coding Guidelines
diff --git a/doc/src/Ps2epsi.rst b/doc/src/Ps2epsi.rst
index f71eb7583..4f345a6f2 100644
--- a/doc/src/Ps2epsi.rst
+++ b/doc/src/Ps2epsi.rst
@@ -1,4 +1,4 @@
-.. Copyright (C) 2001-2022 Artifex Software, Inc.
+.. Copyright (C) 2001-2023 Artifex Software, Inc.
.. All Rights Reserved.
.. title:: Convert PostScript to Encapsulated PostScript Interchange Format
diff --git a/doc/src/Psfiles.rst b/doc/src/Psfiles.rst
index 2346447f5..2f3fb525e 100644
--- a/doc/src/Psfiles.rst
+++ b/doc/src/Psfiles.rst
@@ -1,4 +1,4 @@
-.. Copyright (C) 2001-2022 Artifex Software, Inc.
+.. Copyright (C) 2001-2023 Artifex Software, Inc.
.. All Rights Reserved.
.. title:: PostScript Files Distributed with Ghostscript
diff --git a/doc/src/Readme.rst b/doc/src/Readme.rst
index 287ac9f22..f9dd9dc83 100644
--- a/doc/src/Readme.rst
+++ b/doc/src/Readme.rst
@@ -1,11 +1,9 @@
-.. Copyright (C) 2001-2022 Artifex Software, Inc.
+.. Copyright (C) 2001-2023 Artifex Software, Inc.
.. All Rights Reserved.
.. title:: Ghostscript Introduction
-
-
.. include:: header.rst
.. _Ghostscript Introduction:
@@ -107,7 +105,7 @@ URW Font Information
The set of truetype fonts in the urwfonts directory are necessary for the PCL/XL interpreter to function properly but they ARE NOT FREE SOFTWARE and are NOT distributed under the GNU GPL/AGPL. They can instead be redistributed under the `AFPL`_ license which bars commercial use.
-If your copy of GhostPDL includes these fonts, you should have received a copy of the Aladdin Free Public License, usually in a file called COPYING.AFPL. If not, please contact Artifex Software, Inc. 1305 Grant Avenue - Suite 200, Novato, CA 94945 USA, or visit `Artifex`_
+If your copy of GhostPDL includes these fonts, you should have received a copy of the Aladdin Free Public License, usually in a file called COPYING.AFPL. If not, please contact Artifex Software, Inc. 39 Mesa Street, Suite 108A, San Francisco, CA 94129, USA, or visit `Artifex`_
@@ -225,4 +223,4 @@ Much other material about Ghostscript is available on the World Wide Web, both a
.. _GPL Ghostscript releases: https://github.com/ArtifexSoftware/ghostpdl/blob/master/doc/COPYING
-.. include:: footer.rst \ No newline at end of file
+.. include:: footer.rst
diff --git a/doc/src/SampleDownscaleDevice.rst b/doc/src/SampleDownscaleDevice.rst
index 49a2f1738..4040792e1 100644
--- a/doc/src/SampleDownscaleDevice.rst
+++ b/doc/src/SampleDownscaleDevice.rst
@@ -1,4 +1,4 @@
-.. Copyright (C) 2001-2022 Artifex Software, Inc.
+.. Copyright (C) 2001-2023 Artifex Software, Inc.
.. All Rights Reserved.
.. title:: Sample CMYK 32-bit Device that Supports Post Rendering Processing
diff --git a/doc/src/SavedPages.rst b/doc/src/SavedPages.rst
index 84acb5d63..2f409b270 100644
--- a/doc/src/SavedPages.rst
+++ b/doc/src/SavedPages.rst
@@ -1,4 +1,4 @@
-.. Copyright (C) 2001-2022 Artifex Software, Inc.
+.. Copyright (C) 2001-2023 Artifex Software, Inc.
.. All Rights Reserved.
.. title:: Using Saved Pages
diff --git a/doc/src/Source.rst b/doc/src/Source.rst
index 0c55876cd..cddcea5ba 100644
--- a/doc/src/Source.rst
+++ b/doc/src/Source.rst
@@ -1,4 +1,4 @@
-.. Copyright (C) 2001-2022 Artifex Software, Inc.
+.. Copyright (C) 2001-2023 Artifex Software, Inc.
.. All Rights Reserved.
.. title:: Guide to Ghostscript Source Code
diff --git a/doc/src/Unix-lpr.rst b/doc/src/Unix-lpr.rst
index 9de9a03da..404745a17 100644
--- a/doc/src/Unix-lpr.rst
+++ b/doc/src/Unix-lpr.rst
@@ -1,4 +1,4 @@
-.. Copyright (C) 2001-2022 Artifex Software, Inc.
+.. Copyright (C) 2001-2023 Artifex Software, Inc.
.. All Rights Reserved.
.. title:: Setting Up a Unix lpr Filter for Ghostscript
diff --git a/doc/src/UnsupportedDevices.rst b/doc/src/UnsupportedDevices.rst
index b7122f821..65eb5aa28 100644
--- a/doc/src/UnsupportedDevices.rst
+++ b/doc/src/UnsupportedDevices.rst
@@ -1,4 +1,4 @@
-.. Copyright (C) 2001-2022 Artifex Software, Inc.
+.. Copyright (C) 2001-2023 Artifex Software, Inc.
.. All Rights Reserved.
.. title:: Unsupported devices
@@ -10,7 +10,7 @@
-Unsupported devices
+Unsupported Devices
===================================
diff --git a/doc/src/Use.rst b/doc/src/Use.rst
index 6a570fe1c..19b315ea5 100644
--- a/doc/src/Use.rst
+++ b/doc/src/Use.rst
@@ -1,4 +1,4 @@
-.. Copyright (C) 2001-2022 Artifex Software, Inc.
+.. Copyright (C) 2001-2023 Artifex Software, Inc.
.. All Rights Reserved.
.. title:: Using Ghostscript
@@ -9,7 +9,7 @@
.. _Use.htm:
-Using Ghostscript
+Using
===================================
@@ -28,23 +28,29 @@ The command line to invoke Ghostscript is essentially the same on all systems, a
Here are some basic examples. The details of how these work are described below.
-To view a file:
+To view a file
+~~~~~~~~~~~~~~~~~~
.. code-block:: bash
gs -dSAFER -dBATCH document.pdf
-You'll be prompted to press return between pages.
+.. note::
+
+ You'll be prompted to press return between pages.
-To convert a figure to an image file:
+To convert a figure to an image file
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: bash
gs -dSAFER -dBATCH -dNOPAUSE -sDEVICE=png16m -dGraphicsAlphaBits=4 \
-sOutputFile=tiger.png tiger.eps
-To render the same image at 300 dpi:
+
+To render the same image at 300 dpi
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: bash
@@ -52,7 +58,8 @@ To render the same image at 300 dpi:
-sOutputFile=tiger_300.png tiger.eps
-To render a figure in grayscale:
+To render a figure in grayscale
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: bash
@@ -61,7 +68,8 @@ To render a figure in grayscale:
gs -dSAFER -dBATCH -dNOPAUSE -sDEVICE=pnggray -sOutputFile=figure.png figure.pdf
-To rasterize a whole document:
+To rasterize a whole document
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: bash
@@ -69,8 +77,8 @@ To rasterize a whole document:
-dTextAlphaBits=4 -sOutputFile='paper-%00d.pgm' paper.ps
-There are also a number of utility scripts for common to convert a PostScript document to PDF:
-
+Convert a PostScript document to PDF
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: bash
@@ -80,13 +88,16 @@ There are also a number of utility scripts for common to convert a PostScript do
The output is saved as ``file.pdf``.
-There are other utility scripts besides ``ps2pdf``, including ``pdf2ps``, ``ps2epsi``, ``pdf2dsc``, ``ps2ascii``, ``ps2ps`` and ``ps2ps2``. These just call Ghostscript with the appropriate (if complicated) set of options. You can use the 'ps2' set with eps files.
-Ghostscript is capable of interpreting PostScript, encapsulated PostScript (EPS), DOS EPS (EPSF), and Adobe Portable Document Format (PDF). The interpreter reads and executes the files in sequence, using the method described under "`File searching`_" to find them.
+.. note::
+
+ There are other utility scripts besides ``ps2pdf``, including ``pdf2ps``, ``ps2epsi``, ``pdf2dsc``, ``ps2ascii``, ``ps2ps`` and ``ps2ps2``. These just call Ghostscript with the appropriate (if complicated) set of options. You can use the 'ps2' set with eps files.
+
+ Ghostscript is capable of interpreting PostScript, encapsulated PostScript (EPS), DOS EPS (EPSF), and Adobe Portable Document Format (PDF). The interpreter reads and executes the files in sequence, using the method described under "`File searching`_" to find them.
-The interpreter runs in interactive mode by default. After processing the files given on the command line (if any) it reads further lines of PostScript language commands from the primary input stream, normally the keyboard, interpreting each line separately. To quit the interpreter, type "``quit``". The ``-dBATCH -dNOPAUSE`` options in the examples above disable the interactive prompting. The interpreter also quits gracefully if it encounters end-of-file or control-C.
+ The interpreter runs in interactive mode by default. After processing the files given on the command line (if any) it reads further lines of PostScript language commands from the primary input stream, normally the keyboard, interpreting each line separately. To quit the interpreter, type "``quit``". The ``-dBATCH -dNOPAUSE`` options in the examples above disable the interactive prompting. The interpreter also quits gracefully if it encounters end-of-file or *control-C*.
-The interpreter recognizes many options. An option may appear anywhere in the command line, and applies to all files named after it on the line. Many of them include "=" followed by a parameter. The most important are described in detail here. Please see the reference sections on `Command line options`_ and `Devices <Devices.htm>`_ for a more complete listing.
+ The interpreter recognizes many options. An option may appear anywhere in the command line, and applies to all files named after it on the line. Many of them include "=" followed by a parameter. The most important are described in detail here. Please see the reference sections on `Command line options`_ and `Devices <Devices.htm>`_ for a more complete listing.
diff --git a/doc/src/VectorDevices.rst b/doc/src/VectorDevices.rst
index 34186abb6..eb4ee92ed 100644
--- a/doc/src/VectorDevices.rst
+++ b/doc/src/VectorDevices.rst
@@ -1,4 +1,4 @@
-.. Copyright (C) 2001-2022 Artifex Software, Inc.
+.. Copyright (C) 2001-2023 Artifex Software, Inc.
.. All Rights Reserved.
.. title:: High Level Devices
diff --git a/doc/src/_static/custom.css b/doc/src/_static/custom.css
index fede05bf2..db168023d 100644
--- a/doc/src/_static/custom.css
+++ b/doc/src/_static/custom.css
@@ -4,6 +4,10 @@
height: auto;
}
+.wy-nav-content .icon-home {
+ width: auto;
+}
+
/* main document page: ensures pages fit to the available width and height */
.wy-nav-content {
min-width: 100%;
diff --git a/doc/src/conf.py b/doc/src/conf.py
index 743a5e0b6..952a342b2 100644
--- a/doc/src/conf.py
+++ b/doc/src/conf.py
@@ -1,7 +1,9 @@
# -*- coding: utf-8 -*-
#
+import re
import sys
import os
+import datetime
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
@@ -38,18 +40,38 @@ source_suffix = ".rst"
# source_encoding = 'utf-8-sig'
# The master toctree document.
-master_doc = "toc"
+master_doc = "index"
# General information about the project.
project = "Ghostscript"
-copyright = "1988-2022, Artifex"
+thisday = datetime.date.today()
+
+copyright = "1988-" + str(thisday.year) + ", Artifex"
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The full version, including alpha/beta/rc tags.
-release = "10.01.0"
+major = None
+minor = None
+patch = None
+
+_path = os.path.abspath(f'{__file__}/../../../base/version.mak')
+with open(_path) as f:
+ for line in f:
+ if not major:
+ major = re.search('GS_VERSION_MAJOR=([0-9]+$)', line)
+ if not minor:
+ minor = re.search('GS_VERSION_MINOR=([0-9]+$)', line)
+ if not patch:
+ patch = re.search('GS_VERSION_PATCH=([0-9]+$)', line)
+
+ if major and minor and patch:
+ release = major.group(1) + "." + minor.group(1) + "." + patch.group(1)
+ print(f'{__file__}: setting version from {_path}: {release}')
+ else:
+ raise Exception(f'Failed to find `Ghostscript version = ...` in {_path}')
# The short X.Y version
version = release
@@ -202,7 +224,7 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
- ("toc", "Ghostscript.tex", u"Ghostscript Documentation", u"Artifex", "manual")
+ ("index", "Ghostscript.tex", u"Ghostscript Documentation", u"Artifex", "manual")
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
@@ -228,7 +250,7 @@ latex_domain_indices = True
# Grouping the document tree into PDF files. List of tuples
# (source start file, target name, title, author).
-pdf_documents = [("toc", "Ghostscript", "Ghostscript Manual", "Artifex")]
+pdf_documents = [("index", "Ghostscript", "Ghostscript Manual", "Artifex")]
# A comma-separated list of custom stylesheets. Example:
#pdf_stylesheets = ["sphinx", "bahnschrift", "a4"]
diff --git a/doc/src/footer.rst b/doc/src/footer.rst
index 50ff5d198..c3969d6fc 100644
--- a/doc/src/footer.rst
+++ b/doc/src/footer.rst
@@ -15,7 +15,7 @@
<hr>
- This software is provided AS-IS with no warranty, either express or implied. This software is distributed under license and may not be copied, modified or distributed except as expressly authorized under the terms of that license. Refer to licensing information at <a href="https://www.artifex.com">artifex.com</a> or contact Artifex Software, Inc., 1305 Grant Avenue - Suite 200, Novato, CA 94945, U.S.A., +1(415)492-9861, for further information.
+ This software is provided AS-IS with no warranty, either express or implied. This software is distributed under license and may not be copied, modified or distributed except as expressly authorized under the terms of that license. Refer to licensing information at <a href="https://www.artifex.com">artifex.com</a> or contact Artifex Software, Inc., 39 Mesa Street, Suite 108A, San Francisco, CA 94129, USA, for further information.
.. note - this ensures that the Sphinx build system will pull in the image (as it is referenced in an RST file) to _images,
we don't want to display it via rst markup due to limitations (hence width:0), however we do want it available for our raw HTML
diff --git a/doc/src/header.rst b/doc/src/header.rst
index f97b137d3..2943b243c 100644
--- a/doc/src/header.rst
+++ b/doc/src/header.rst
@@ -1,3 +1,6 @@
+.. Copyright (C) 2001-2023 Artifex Software, Inc.
+.. All Rights Reserved.
+
.. meta::
:description: The Ghostscript documentation
:keywords: Ghostscript command line, Ghostscript options, Ghostscript command line examples, Ghostscript parameters, install Ghostscript, dpdfsettings, Ghostscript sdevice, how to use Ghostscript, eps, Ghostscript language bindings, Ghostscript command line general switches
diff --git a/doc/src/images/ghostscript-logo.png b/doc/src/images/ghostscript-logo.png
new file mode 100644
index 000000000..1250bf7d6
--- /dev/null
+++ b/doc/src/images/ghostscript-logo.png
Binary files differ
diff --git a/doc/src/index.rst b/doc/src/index.rst
index 2a6ceb608..759c59875 100644
--- a/doc/src/index.rst
+++ b/doc/src/index.rst
@@ -1,4 +1,85 @@
-.. Copyright (C) 2001-2022 Artifex Software, Inc.
+.. Copyright (C) 2001-2023 Artifex Software, Inc.
.. All Rights Reserved.
-.. include:: Readme.rst \ No newline at end of file
+.. include:: header.rst
+
+.. This is the TOC in the sidebar!
+
+
+Welcome to :title:`Ghostscript`
+================================
+
+.. image:: images/ghostscript-logo.png
+ :align: left
+ :scale: 20%
+
+:title:`Ghostscript` is an interpreter for the `PostScript® <https://en.wikipedia.org/wiki/PostScript>`_ language and `PDF <https://en.wikipedia.org/wiki/PDF>`_ files. It is available under either the `GNU GPL Affero license <https://www.gnu.org/licenses/agpl-3.0.html>`_ or `licensed for commercial <https://artifex.com/licensing/commercial/>`_ use from `Artifex Software, Inc <https://artifex.com/>`_. It has been under active development for over 30 years and has been ported to several different systems during this time. Ghostscript consists of a PostScript interpreter layer and a graphics library.
+
+|
+
+----
+
+.. toctree::
+ :caption: About
+ :maxdepth: 1
+
+ Readme.rst
+ News.rst
+
+.. toctree::
+ :caption: Ghostscript User Guide
+ :maxdepth: 1
+
+ Make.rst
+ Install.rst
+ Use.rst
+
+
+.. toctree::
+ :caption: Developing with Ghostscript
+ :maxdepth: 1
+
+ Develop.rst
+ API.rst
+ Lib.rst
+ LanguageBindings.rst
+ Language.rst
+ thirdparty.rst
+
+.. toctree::
+ :caption: Devices
+ :maxdepth: 1
+
+ Devices.rst
+ VectorDevices.rst
+ Drivers.rst
+ UnsupportedDevices.rst
+ SampleDownscaleDevice.rst
+
+.. toctree::
+ :caption: Coding Guidelines
+ :maxdepth: 1
+
+ Source.rst
+ C-style.rst
+ Ps-style.rst
+
+
+
+
+
+
+.. toctree::
+ :caption: Other
+ :maxdepth: 1
+
+ GPDL.rst
+ Ps2epsi.rst
+ Psfiles.rst
+ Fonts.rst
+ GhostscriptColorManagement.rst
+ Unix-lpr.rst
+
+
+.. include:: footer.rst
+
diff --git a/doc/src/thirdparty.rst b/doc/src/thirdparty.rst
index af98dd34f..2fa82308a 100644
--- a/doc/src/thirdparty.rst
+++ b/doc/src/thirdparty.rst
@@ -1,4 +1,4 @@
-.. Copyright (C) 2001-2022 Artifex Software, Inc.
+.. Copyright (C) 2001-2023 Artifex Software, Inc.
.. All Rights Reserved.
.. title:: Third Party Libraries Used by Ghostscript and GhostPDL
@@ -9,10 +9,13 @@
.. _thirdparty.htm:
-Third Party Libraries Used by Ghostscript and GhostPDL
+Third Party Libraries
=========================================================
+Third Party Libraries used by Ghostscript and GhostPDL
+---------------------------------------------------------
+
The table below details the third party libraries that Ghostscript and/or GhostPDL include, the versions QA tested and shipped with our releases, the relevant license, and the "upstream" URL.
diff --git a/doc/src/toc.rst b/doc/src/toc.rst
index 09a9929d3..afcc9d1db 100644
--- a/doc/src/toc.rst
+++ b/doc/src/toc.rst
@@ -18,6 +18,7 @@ Table of Contents
VectorDevices.rst
Drivers.rst
Language.rst
+ GPDL.rst
Lib.rst
Develop.rst
C-style.rst