You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@buildstream.apache.org by tv...@apache.org on 2022/04/05 10:04:51 UTC

[buildstream-plugins] 36/49: doc: Adding docs build.

This is an automated email from the ASF dual-hosted git repository.

tvb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/buildstream-plugins.git

commit c74456f7cb9389414378f73371f5773b660ceaa8
Author: Tristan van Berkom <tr...@codethink.co.uk>
AuthorDate: Thu Mar 24 14:26:22 2022 +0900

    doc: Adding docs build.
    
    Now `tox -e docs` properly generates the documentation.
---
 doc/Makefile                  |  97 ++++++++++++
 doc/source/conf.py            | 345 ++++++++++++++++++++++++++++++++++++++++++
 doc/source/index.rst          |  31 ++++
 doc/source/plugin.rsttemplate |   4 +
 doc/sphinx-build3             |  15 ++
 5 files changed, 492 insertions(+)

diff --git a/doc/Makefile b/doc/Makefile
new file mode 100644
index 0000000..eae1340
--- /dev/null
+++ b/doc/Makefile
@@ -0,0 +1,97 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    = -W
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+# Fix for when python is mapped to python2 not python3
+# This is an issue in the sphinx-build script provided in the default install
+# because it uses the generic python env, so we need to have a copy of this script
+# but with an explicit call to python3.
+#
+# Why python3? We are using some features of sphinx that are only implemented
+# currently in python3
+#
+PYV=$(shell python -c "import sys;t='{v[0]}'.format(v=list(sys.version_info[:2]));sys.stdout.write(t)")
+
+ifeq ($(PYV), 2)
+	SPHINXBUILD = ./sphinx-build3
+endif
+
+.PHONY: all clean templates html devhelp
+
+# Canned recipe for generating plugin api skeletons
+#   $1 = the plugin directory
+#   $2 = the output docs directory
+#
+# Explanation:
+#
+#   Sphinx does not have any option for skipping documentation,
+#   we don't want to document plugin code because nobody uses that
+#   but we do want to use module-level docstrings in plugins in
+#   order to explain how plugins work.
+#
+#   For this purpose, we replace sphinx-apidoc with a simple
+#   makefile rule which generates a template slightly differently
+#   from how sphinx does it, allowing us to get what we want
+#   from plugin documentation.
+#
+define plugin-doc-skeleton
+    @for file in $$(find ${1}/${2} -name "*.py" ! -name "_*"); do \
+        base=$$(basename $$file);                                   \
+        module=${2}.$${base%.py};                                        \
+        modname=$${base%.py};                                       \
+        echo -n "Generating source/${2}/$${modname}.rst... ";       \
+        sed -e "s|@@MODULENAME@@|$${modname}|g"                     \
+            -e "s|@@MODULE@@|$${module}|g"                          \
+            source/plugin.rsttemplate >                             \
+            source/${2}/$${modname}.rst.tmp &&                      \
+            mv source/${2}/$${modname}.rst.tmp source/${2}/$${modname}.rst || exit 1; \
+        echo "Done."; \
+    done
+endef
+
+# We set PYTHONPATH here because source/conf.py sys.modules hacks don't seem to help sphinx-build import the plugins
+all: html devhelp
+
+clean: templates-clean
+	rm -rf build
+
+# Generate rst templates for the docs using a mix of sphinx-apidoc and
+# our 'plugin-doc-skeleton' routine for plugin pages.
+templates:
+	mkdir -p source/elements
+	mkdir -p source/sources
+	$(call plugin-doc-skeleton,$(CURDIR)/../src/buildstream_plugins,elements)
+	$(call plugin-doc-skeleton,$(CURDIR)/../src/buildstream_plugins,sources)
+
+templates-clean:
+	rm -rf source/elements
+	rm -rf source/sources
+
+# Targets which generate docs with sphinx build
+#
+#
+html devhelp: templates
+	@echo "Building $@..."
+	PYTHONPATH=$(CURDIR)/../src/buildstream_plugins \
+	    $(SPHINXBUILD) -b $@ $(ALLSPHINXOPTS) "$(BUILDDIR)/$@" \
+	    $(wildcard source/*.rst) \
+	    $(wildcard source/elements/*.rst) \
+	    $(wildcard source/sources/*.rst)
+	@echo
+	@echo "Build of $@ finished, output: $(CURDIR)/$(BUILDDIR)/$@"
+
+testy:
+	@echo "Using $(SPHINXBUILD)"
+	@echo "Py is $(PYV)"
diff --git a/doc/source/conf.py b/doc/source/conf.py
new file mode 100644
index 0000000..fb238b9
--- /dev/null
+++ b/doc/source/conf.py
@@ -0,0 +1,345 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# BuildStream documentation build configuration file, created by
+# sphinx-quickstart on Mon Nov  7 21:03:37 2016.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# 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('..'))
+
+# -- 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 = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.extlinks',
+]
+
+# 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 encoding of source files.
+#
+# source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'BuildStream Plugins'
+copyright = '2022, BuildStream Developers'
+author = 'BuildStream Developers'
+
+# 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 short X.Y version.
+version = '1.91'
+# The full version, including alpha/beta/rc tags.
+release = '1.91.0'
+
+# 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
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#
+# today = ''
+#
+# Else, today_fmt is used as the format for a strftime call.
+#
+# today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#
+# default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#
+# add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#
+add_module_names = False
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#
+# show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+modindex_common_prefix = [ 'buildstream.' ]
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+# keep_warnings = False
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- 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 = 'sphinx_rtd_theme'
+
+# 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 themes here, relative to this directory.
+# html_theme_path = []
+
+# The name for this set of Sphinx documents.
+# "<project> v<release> documentation" by default.
+#
+# html_title = 'BuildStream v0.1'
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#
+# html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#
+# html_logo = None
+
+# The name of an image file (relative to this directory) to use as a favicon of
+# the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#
+# html_favicon = None
+
+# 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 = []
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#
+# html_extra_path = []
+
+# If not None, a 'Last updated on:' timestamp is inserted at every page
+# bottom, using the given strftime format.
+# The empty string is equivalent to '%b %d, %Y'.
+#
+# html_last_updated_fmt = None
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#
+# html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#
+# html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#
+# html_additional_pages = {}
+
+# If false, no module index is generated.
+#
+# html_domain_indices = True
+
+# If false, no index is generated.
+#
+# html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#
+# html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#
+# html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#
+# html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#
+# html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#
+# html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+# html_file_suffix = None
+
+# Language to be used for generating the HTML full-text search index.
+# Sphinx supports the following languages:
+#   'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
+#   'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh'
+#
+# html_search_language = 'en'
+
+# A dictionary with options for the search language support, empty by default.
+# 'ja' uses this config value.
+# 'zh' user can custom change `jieba` dictionary path.
+#
+# html_search_options = {'type': 'default'}
+
+# The name of a javascript file (relative to the configuration directory) that
+# implements a search results scorer. If empty, the default will be used.
+#
+# html_search_scorer = 'scorer.js'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'BuildStreamdoc'
+
+# -- 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, 'BuildStream.tex', 'BuildStream Plugins Documentation',
+     'BuildStream Developers', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#
+# latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#
+# latex_use_parts = False
+
+# If true, show page references after internal links.
+#
+# latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#
+# latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#
+# latex_appendices = []
+
+# It false, will not define \strong, \code, 	itleref, \crossref ... but only
+# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
+# packages.
+#
+# latex_keep_old_macro_names = True
+
+# If false, no module index is generated.
+#
+# latex_domain_indices = True
+
+
+# -- 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, 'buildstream', 'BuildStream Documentation',
+     [author], 1)
+]
+
+# If true, show URL addresses after external links.
+#
+# man_show_urls = False
+
+
+# -- 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, 'BuildStream', 'BuildStream Plugins Documentation',
+     author, 'BuildStream', 'A collection of BuildStream plugins.',
+     'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#
+# texinfo_appendices = []
+
+# If false, no module index is generated.
+#
+# texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#
+# texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#
+# texinfo_no_detailmenu = False
+
+autodoc_member_order = 'bysource'
diff --git a/doc/source/index.rst b/doc/source/index.rst
new file mode 100644
index 0000000..3d17b69
--- /dev/null
+++ b/doc/source/index.rst
@@ -0,0 +1,31 @@
+.. toctree::
+   :maxdepth: 2
+
+BuildStream Plugins Documentation
+=================================
+This is a collection of plugins to use with Buildstream.
+
+To these plugins in your project, follow the
+`plugin loading documentation <https://docs.buildstream.build/master/format_project.html#loading-plugins>`_.
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Element Plugins
+
+   elements/autotools
+   elements/cmake
+   elements/make
+   elements/meson
+   elements/pip
+   elements/setuptools
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Source Plugins
+
+   sources/bzr
+   sources/cargo
+   sources/docker
+   sources/git
+   sources/patch
+   sources/pip
diff --git a/doc/source/plugin.rsttemplate b/doc/source/plugin.rsttemplate
new file mode 100644
index 0000000..11e090f
--- /dev/null
+++ b/doc/source/plugin.rsttemplate
@@ -0,0 +1,4 @@
+@@MODULENAME@@ plugin
+============================================
+
+.. automodule:: @@MODULE@@
diff --git a/doc/sphinx-build3 b/doc/sphinx-build3
new file mode 100755
index 0000000..590fd52
--- /dev/null
+++ b/doc/sphinx-build3
@@ -0,0 +1,15 @@
+#!/usr/bin/python3
+# -*- coding: utf-8 -*-
+"""
+Same as /usr/bin/sphinx-build but with different
+interpreter
+"""
+
+import sys
+
+if __name__ == '__main__':
+    from sphinx import main, make_main
+    if sys.argv[1:2] == ['-M']:
+        sys.exit(make_main(sys.argv))
+    else:
+        sys.exit(main(sys.argv))
\ No newline at end of file