Commit 22d53f928f3056394b1b82baa1141b47bfe5fb5f
1 parent
f8787d9f
Sphinx docs: tweak output of sphinx-quickstart
Showing
2 changed files
with
7 additions
and
54 deletions
manual/conf.py
| 1 | # Configuration file for the Sphinx documentation builder. | 1 | # Configuration file for the Sphinx documentation builder. |
| 2 | # | 2 | # |
| 3 | -# This file only contains a selection of the most common options. For a full | ||
| 4 | -# list see the documentation: | 3 | +# This file only contains a selection of the most common options. For |
| 4 | +# a full list see the documentation: | ||
| 5 | # https://www.sphinx-doc.org/en/master/usage/configuration.html | 5 | # https://www.sphinx-doc.org/en/master/usage/configuration.html |
| 6 | - | ||
| 7 | -# -- Path setup -------------------------------------------------------------- | ||
| 8 | - | ||
| 9 | -# If extensions (or modules to document with autodoc) are in another directory, | ||
| 10 | -# add these directories to sys.path here. If the directory is relative to the | ||
| 11 | -# documentation root, use os.path.abspath to make it absolute, like shown here. | ||
| 12 | # | 6 | # |
| 13 | -# import os | ||
| 14 | -# import sys | ||
| 15 | -# sys.path.insert(0, os.path.abspath('.')) | ||
| 16 | - | ||
| 17 | - | ||
| 18 | -# -- Project information ----------------------------------------------------- | 7 | +# To see the default sample conf.py, run sphinx-quickstart in an empty |
| 8 | +# directory. Most of the original comments and options were removed. | ||
| 19 | 9 | ||
| 20 | project = 'QPDF' | 10 | project = 'QPDF' |
| 21 | -copyright = '2021, Jay Berkenbilt' | 11 | +copyright = '2005-2021, Jay Berkenbilt' |
| 22 | author = 'Jay Berkenbilt' | 12 | author = 'Jay Berkenbilt' |
| 23 | - | ||
| 24 | -# The full version, including alpha/beta/rc tags | ||
| 25 | release = '10.4.0' | 13 | release = '10.4.0' |
| 26 | - | ||
| 27 | - | ||
| 28 | -# -- General configuration --------------------------------------------------- | ||
| 29 | - | ||
| 30 | -# Add any Sphinx extension module names here, as strings. They can be | ||
| 31 | -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom | ||
| 32 | -# ones. | ||
| 33 | -extensions = [ | ||
| 34 | -] | ||
| 35 | - | ||
| 36 | -# Add any paths that contain templates here, relative to this directory. | ||
| 37 | -templates_path = ['_templates'] | ||
| 38 | - | ||
| 39 | -# List of patterns, relative to source directory, that match files and | ||
| 40 | -# directories to ignore when looking for source files. | ||
| 41 | -# This pattern also affects html_static_path and html_extra_path. | ||
| 42 | -exclude_patterns = [] | ||
| 43 | - | ||
| 44 | - | ||
| 45 | -# -- Options for HTML output ------------------------------------------------- | ||
| 46 | - | ||
| 47 | -# The theme to use for HTML and HTML Help pages. See the documentation for | ||
| 48 | -# a list of builtin themes. | ||
| 49 | -# | ||
| 50 | html_theme = 'alabaster' | 14 | html_theme = 'alabaster' |
| 51 | - | ||
| 52 | -# Add any paths that contain custom static files (such as style sheets) here, | ||
| 53 | -# relative to this directory. They are copied after the builtin static files, | ||
| 54 | -# so a file named "default.css" will overwrite the builtin "default.css". | ||
| 55 | -html_static_path = ['_static'] | ||
| 56 | \ No newline at end of file | 15 | \ No newline at end of file |
manual/index.rst
| 1 | -.. QPDF documentation master file, created by | ||
| 2 | - sphinx-quickstart on Sat Dec 11 16:34:52 2021. | ||
| 3 | - You can adapt this file completely to your liking, but it should at least | ||
| 4 | - contain the root `toctree` directive. | ||
| 5 | 1 | ||
| 6 | -Welcome to QPDF's documentation! | ||
| 7 | -================================ | 2 | +QPDF version |release| |
| 3 | +====================== | ||
| 8 | 4 | ||
| 9 | .. toctree:: | 5 | .. toctree:: |
| 10 | :maxdepth: 2 | 6 | :maxdepth: 2 |
| 11 | :caption: Contents: | 7 | :caption: Contents: |
| 12 | 8 | ||
| 13 | - | ||
| 14 | - | ||
| 15 | Indices and tables | 9 | Indices and tables |
| 16 | ================== | 10 | ================== |
| 17 | 11 |