From dff6bfeddcd66418082741559a23f2647679c432 Mon Sep 17 00:00:00 2001 From: Rohan McGovern Date: Thu, 21 Mar 2019 10:29:08 +1000 Subject: [PATCH] Get docs working via Travis & github pages Basic skeleton of docs are in place. Currently, the classes/methods appearing in "API reference" should be considered as examples only. I'm not sure exactly what should go in there as it still seems a bit unclear what is and isn't public API. The main goal here is to get the doc building toolchain up and running. --- .travis.yml | 5 ++ docs/Makefile | 19 +++++ docs/conf.py | 202 +++++++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 43 ++++++++++ scripts/push-docs | 36 ++++++++ ubipop/__init__.py | 13 ++- 6 files changed, 315 insertions(+), 3 deletions(-) create mode 100644 docs/Makefile create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100755 scripts/push-docs diff --git a/.travis.yml b/.travis.yml index c82213b..7d0c16d 100644 --- a/.travis.yml +++ b/.travis.yml @@ -11,7 +11,12 @@ matrix: env: TOX_ENV=static - python: '3.5' env: TOX_ENV=cov-travis DEPLOY=1 + - python: "3.5" + env: TOX_ENV=docs script: tox -e $TOX_ENV +after_success: +- test $TOX_ENV = docs && scripts/push-docs + deploy: provider: pypi user: content-delivery-release-bot diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..298ea9e --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,19 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..48d31bf --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,202 @@ +# -*- 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 = 'ubi-population-tool' +copyright = '2019, Red Hat' +author = 'Red Hat' + +# 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 = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.intersphinx', + 'sphinx.ext.napoleon', + 'sphinx.ext.githubpages', +] + +# 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 = { + 'github_user': 'release-engineering', + 'github_repo': 'ubi-population-tool', + 'github_button': False, + 'github_banner': True, + 'description': 'A python library and cli for populating ubi repositories', + 'extra_nav_links': { + 'Index': 'genindex.html', + 'Source': 'https://github.com/release-engineering/ubi-population-tool', + 'PyPI': 'https://pypi.org/project/ubi-population-tool', + } +} + +# 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 = {} +html_sidebars = { + '**': [ + 'about.html', + 'navigation.html', + 'relations.html', + 'searchbox.html', + 'donate.html', + ] +} + + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = 'ubi-population-tooldoc' + + +# -- 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, 'ubi-population-tool.tex', 'ubi-population-tool Documentation', + 'Red Hat', '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, 'ubi-population-tool', 'ubi-population-tool 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, 'ubi-population-tool', 'ubi-population-tool Documentation', + author, 'ubi-population-tool', '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'] + + +# -- Extension configuration ------------------------------------------------- +autoclass_content = 'both' +intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..b2da1cf --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,43 @@ +ubi-population-tool +=================== + +A python library and cli for populating ubi repositories. + +.. contents:: + :local: + +Quick Start +----------- + +Install ubi-population-tool from PyPI: + +:: + + pip install ubi-population-tool + +Then run ``ubipop`` command against a Pulp server, e.g. + +:: + + ubipop \ + --pulp-hostname mypulp.example.com \ + --user admin --password admin \ + --conf-src https://mygit.example.com/ubi/config + +Or import & use classes from ``ubipop`` module: + +.. code-block:: python + + from ubipop import UbiPopulateRunner + + UbiPopulateRunner(...).run_ubi_population() + + +API Reference +------------- + +.. autoclass:: ubipop.UbiPopulate + :members: + +.. autoclass:: ubipop.UbiPopulateRunner + :members: \ No newline at end of file diff --git a/scripts/push-docs b/scripts/push-docs new file mode 100755 index 0000000..555b5ff --- /dev/null +++ b/scripts/push-docs @@ -0,0 +1,36 @@ +#!/bin/bash +set -e + +REPO=release-engineering/ubi-population-tool + +enabled(){ + if [ "$TRAVIS_BRANCH" != "master" ] || [ "$TRAVIS_PULL_REQUEST" != "false" ]; then + return 1 + fi +} + +set -x + +rev=$(git rev-parse --short HEAD) +version=$(python ./setup.py --version | cut -d. -f1,2) + +cd docs/_build/html + +git init +git config user.name "${GITHUB_AUTHOR:-doc bot}" +git config user.email "${GITHUB_EMAIL:-no-reply@redhat.com}" + +if enabled; then + git remote add origin "https://$GITHUB_TOKEN@github.com/${REPO}.git" + git fetch origin + git reset origin/gh-pages || git reset origin/master +fi + +git add -A . +git commit -m "Build documentation for ${version} at ${rev}" + +if enabled; then + git push -q origin HEAD:refs/heads/gh-pages +else + echo "Docs would now be pushed, if this were submitted to master." +fi diff --git a/ubipop/__init__.py b/ubipop/__init__.py index eb319cb..1059c3c 100644 --- a/ubipop/__init__.py +++ b/ubipop/__init__.py @@ -502,9 +502,16 @@ def get_packages_names_by_profiles(self, profiles, modules): """ Gather package names by module profiles, if no profiles provided, add packages from all profiles - :param profiles: list of str profiles ubi config - :param modules: list pulp.Modules - :return: list package names str + + Args: + profiles (list of str): + profiles ubi config + modules (list of _pulp.Module): + modules to process + + Returns: + list of str: + names of packages within matching modules & profiles """ packages_names = []