From 6d8823b81162c18406d40ec59bd252cfdf1df648 Mon Sep 17 00:00:00 2001 From: Ben McGinnes Date: Wed, 5 Dec 2018 09:17:31 +1100 Subject: python: Sphinx support * Added framework from sphinx-quickstart to lang/python/doc/rst/ so that Python developers already using Sphinx can use the generated reST files with existing documentation systems. * Note that when generating source files from Org-mode, the index page will require manual intervention to match the Sphinx requirements. Signed-off-by: Ben McGinnes --- lang/python/doc/rst/_build/README | 1 + lang/python/doc/rst/_static/README | 1 + lang/python/doc/rst/_templates/README | 1 + lang/python/doc/rst/conf.py | 173 ++++++++++++++++++++++++++++++++++ lang/python/doc/rst/index.rst | 17 +++- lang/python/doc/rst/make.bat | 35 +++++++ 6 files changed, 227 insertions(+), 1 deletion(-) create mode 100644 lang/python/doc/rst/_build/README create mode 100644 lang/python/doc/rst/_static/README create mode 100644 lang/python/doc/rst/_templates/README create mode 100644 lang/python/doc/rst/conf.py create mode 100644 lang/python/doc/rst/make.bat diff --git a/lang/python/doc/rst/_build/README b/lang/python/doc/rst/_build/README new file mode 100644 index 00000000..07d5fbbd --- /dev/null +++ b/lang/python/doc/rst/_build/README @@ -0,0 +1 @@ +Directory for Sphinx's built documentation. \ No newline at end of file diff --git a/lang/python/doc/rst/_static/README b/lang/python/doc/rst/_static/README new file mode 100644 index 00000000..4861a5f4 --- /dev/null +++ b/lang/python/doc/rst/_static/README @@ -0,0 +1 @@ +Directory for static site data (e.g. CSS files). \ No newline at end of file diff --git a/lang/python/doc/rst/_templates/README b/lang/python/doc/rst/_templates/README new file mode 100644 index 00000000..59c631e3 --- /dev/null +++ b/lang/python/doc/rst/_templates/README @@ -0,0 +1 @@ +Directory for HTML templates. \ No newline at end of file diff --git a/lang/python/doc/rst/conf.py b/lang/python/doc/rst/conf.py new file mode 100644 index 00000000..73ecc37d --- /dev/null +++ b/lang/python/doc/rst/conf.py @@ -0,0 +1,173 @@ +# -*- coding: utf-8 -*- +# +# Configuration file for the Sphinx documentation builder. +# +# This file does only contain a selection of the most common options. For a +# full list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- Path setup -------------------------------------------------------------- + +# 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 +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = 'GPGME Python Bindings' +copyright = '2018, The GnuPG Hackers' +author = 'The GnuPG Hackers' + +# The short X.Y version +version = '' +# The full version, including alpha/beta/rc tags +release = '' + + +# -- General configuration --------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = None + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# The default sidebars (for documents that don't match any pattern) are +# defined by theme itself. Builtin themes are using these templates by +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', +# 'searchbox.html']``. +# +# html_sidebars = {} + + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = 'GPGMEPythonBindingsdoc' + + +# -- Options for LaTeX output ------------------------------------------------ + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'GPGMEPythonBindings.tex', 'GPGME Python Bindings Documentation', + 'The GnuPG Hackers', 'manual'), +] + + +# -- Options for manual page output ------------------------------------------ + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'gpgmepythonbindings', 'GPGME Python Bindings Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ---------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'GPGMEPythonBindings', 'GPGME Python Bindings Documentation', + author, 'GPGMEPythonBindings', 'One line description of project.', + 'Miscellaneous'), +] + + +# -- Options for Epub output ------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = project + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +# +# epub_identifier = '' + +# A unique identification for the text. +# +# epub_uid = '' + +# A list of files that should not be packed into the epub file. +epub_exclude_files = ['search.html'] \ No newline at end of file diff --git a/lang/python/doc/rst/index.rst b/lang/python/doc/rst/index.rst index 746391c3..9c4f0f7a 100644 --- a/lang/python/doc/rst/index.rst +++ b/lang/python/doc/rst/index.rst @@ -1,8 +1,15 @@ -.. _top: +.. GPGME Python Bindings documentation master file, created by + sphinx-quickstart on Wed Dec 5 09:04:47 2018. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. GPGME Python Bindings ===================== +.. toctree:: + :maxdepth: 2 + :caption: Contents: + Contents -------- @@ -13,3 +20,11 @@ Contents - `What Was New `__ - `GPGME Python Bindings HOWTO `__ + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/lang/python/doc/rst/make.bat b/lang/python/doc/rst/make.bat new file mode 100644 index 00000000..27f573b8 --- /dev/null +++ b/lang/python/doc/rst/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% + +:end +popd -- cgit v1.2.1