From d16f782c680591f520db563968de0f5887d876d3 Mon Sep 17 00:00:00 2001 From: Sharif Salah Date: Fri, 13 Dec 2019 13:14:48 +0100 Subject: [PATCH] Add initial configuration for Sphinx docs (#563) * Add initial Sphinx files * Add PyOutline and PyCue to sys.path --- docs/Makefile | 19 +++ docs/README.md | 126 +++++++++++++++++++ docs/conf.py | 195 ++++++++++++++++++++++++++++++ docs/index.rst | 18 +++ docs/modules/modules.rst | 7 ++ docs/modules/outline.backend.rst | 24 ++++ docs/modules/outline.modules.rst | 18 +++ docs/modules/outline.plugins.rst | 24 ++++ docs/modules/outline.rst | 94 ++++++++++++++ docs/modules/outline.versions.rst | 24 ++++ 10 files changed, 549 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/README.md create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100644 docs/modules/modules.rst create mode 100644 docs/modules/outline.backend.rst create mode 100644 docs/modules/outline.modules.rst create mode 100644 docs/modules/outline.plugins.rst create mode 100644 docs/modules/outline.rst create mode 100644 docs/modules/outline.versions.rst diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 000000000..298ea9e21 --- /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/README.md b/docs/README.md new file mode 100644 index 000000000..b3ba64189 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,126 @@ +# Building Python APIs reference docs + +This guide explains how to set up your development environment to build the +HTML reference docs for the various Python packages and modules in OpenCue. The +project is also working on publishing the generated API reference docs on +www.opencue.io, but in the meantime you can build the reference HTML locally. +This guide is also useful if you want to build the HTML reference during +development. + +Currently, OpenCue supports building HTML reference docs for the `outline` +package. The `outline` package is the primary package for submitting and +managing jobs in OpenCue. We'll add support for building additional +packages soon. + +## Before you begin + +You must have the following software installed on your machine: + +* Python version 2.7 or greater +* The Python `pip` command +* The Python `virtualenv` tool + +If you don't already have a recent local copy of the OpenCue source code, you +must do one of the following: + +1. Download and unzip the + [OpenCue source code ZIP file](https://github.com/AcademySoftwareFoundation/OpenCue/archive/master.zip). + +2. If you have the `git` command installed on your machine, you can clone + the repository: + + ``` + git clone https://github.com/AcademySoftwareFoundation/OpenCue.git + ``` + +## Building and view the reference docs + +To build and view the HTML reference docs: + +1. Create a Python virtual environment: + + ``` + virtualenv venv + source venv/bin/activate + ``` + +1. Install Sphinx: + + ``` + pip install sphinx sphinx-theme + ``` + +1. Install all other dependencies: + + ``` + pip install -r requirements.txt + ``` + +1. Compile the OpenCue Cuebot protos, as these are dependencies for the + Python packages: + + ``` + cd proto + python -m grpc_tools.protoc -I=. --python_out=../pycue/opencue/compiled_proto --grpc_python_out=../pycue/opencue/compiled_proto ./*.proto + cd .. + ``` + +1. Change to the `docs` directory: + + ``` + cd ../docs + ``` + +1. Build the docs: + + ``` + make html + ``` + +1. To view the HTML output from Sphinx, open the following HTML file in a + browser: + + Note: Currently, Sphinx is only configured to generate HTML docs for the + `outline` package. + + ``` + /OpenCue/docs/_build/html/index.html + ``` + +## Customizing the theme + +To customize the theme for the generated docs: + +1. Open `docs/conf.py` for editing. + +1. Comment the following line: + + ``` + html_theme = 'alabaster' + ``` + +1. Add the followin code, replacing '' with a theme: + + Note: You can browse available themes at https://sphinx-themes.org/. + + ``` + html_theme = '' + import sphinx_theme + html_theme_path = [sphinx_theme.get_html_theme_path()] + ``` + +1. Rebuild the docs: + + ``` + make clean + make html + ``` + +## Submitting changes to the docs + +Before you commit and submit changes as a pull request, remove any generated +HTML output: + +``` +make clean +``` \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 000000000..26577c63d --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,195 @@ +# -*- 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('../pycue')) +sys.path.insert(0, os.path.abspath('../pyoutline')) + + +# -- Project information ----------------------------------------------------- + +project = u'OpenCue' +copyright = u'2019, Academy Software Foundation' +author = u'Academy Software Foundation' + +# The short X.Y version +version = u'0.2.145' +# The full version, including alpha/beta/rc tags +release = u'0.2.145' + + +# -- 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. +# disabled 'sphinx.ext.viewcode', +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.doctest', + 'sphinx.ext.intersphinx', + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.ifconfig', +] + +# 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 = [u'_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. +# +# The default theme +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 = 'OpenCuedoc' + + +# -- 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, 'OpenCue.tex', u'OpenCue documentation', + u'Academy Software Foundation', '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, 'opencue', u'OpenCue 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, 'OpenCue', u'OpenCue documentation', + author, 'OpenCue', 'An open source render management system', + '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 ------------------------------------------------- + +# -- Options for intersphinx extension --------------------------------------- + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'https://docs.python.org/': None} + +# -- Options for todo extension ---------------------------------------------- + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 000000000..80d432de4 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,18 @@ +.. OpenCue documentation master file, created by + sphinx-quickstart on Fri Nov 29 19:54:13 2019. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to the OpenCue API documentation! +========================================= + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/modules/modules.rst b/docs/modules/modules.rst new file mode 100644 index 000000000..e561e803a --- /dev/null +++ b/docs/modules/modules.rst @@ -0,0 +1,7 @@ +outline +======= + +.. toctree:: + :maxdepth: 4 + + outline diff --git a/docs/modules/outline.backend.rst b/docs/modules/outline.backend.rst new file mode 100644 index 000000000..a269dbf5a --- /dev/null +++ b/docs/modules/outline.backend.rst @@ -0,0 +1,24 @@ +outline.backend package +======================= + +Module contents +--------------- + +.. automodule:: outline.backend + :members: + +Submodules +---------- + +outline.backend.cue module +-------------------------- + +.. automodule:: outline.backend.cue + :members: + +outline.backend.local module +---------------------------- + +.. automodule:: outline.backend.local + :members: + diff --git a/docs/modules/outline.modules.rst b/docs/modules/outline.modules.rst new file mode 100644 index 000000000..660c6f3e1 --- /dev/null +++ b/docs/modules/outline.modules.rst @@ -0,0 +1,18 @@ +outline.modules package +======================= + +Module contents +--------------- + +.. automodule:: outline.modules + :members: + +Submodules +---------- + +outline.modules.shell module +---------------------------- + +.. automodule:: outline.modules.shell + :members: + diff --git a/docs/modules/outline.plugins.rst b/docs/modules/outline.plugins.rst new file mode 100644 index 000000000..3a5468b8f --- /dev/null +++ b/docs/modules/outline.plugins.rst @@ -0,0 +1,24 @@ +outline.plugins package +======================= + +Module contents +--------------- + +.. automodule:: outline.plugins + :members: + +Submodules +---------- + +outline.plugins.local module +---------------------------- + +.. automodule:: outline.plugins.local + :members: + +outline.plugins.manager module +------------------------------ + +.. automodule:: outline.plugins.manager + :members: + diff --git a/docs/modules/outline.rst b/docs/modules/outline.rst new file mode 100644 index 000000000..23e01d715 --- /dev/null +++ b/docs/modules/outline.rst @@ -0,0 +1,94 @@ +outline package +=============== + +Subpackages +----------- + +.. toctree:: + + outline.backend + outline.modules + outline.plugins + outline.versions + +Module contents +--------------- + +.. automodule:: outline + :members: + +Submodules +---------- + +outline.config module +--------------------- + +.. automodule:: outline.config + :members: + +outline.constants module +------------------------ + +.. automodule:: outline.constants + :members: + +outline.cuerun module +--------------------- + +.. automodule:: outline.cuerun + :members: + +outline.depend module +--------------------- + +.. automodule:: outline.depend + :members: + +outline.event module +-------------------- + +.. automodule:: outline.event + :members: + +outline.exception module +------------------------ + +.. automodule:: outline.exception + :members: + +outline.executor module +----------------------- + +.. automodule:: outline.executor + :members: + +outline.io module +----------------- + +.. automodule:: outline.io + :members: + +outline.layer module +-------------------- + +.. automodule:: outline.layer + :members: + +outline.loader module +--------------------- + +.. automodule:: outline.loader + :members: + +outline.session module +---------------------- + +.. automodule:: outline.session + :members: + +outline.util module +------------------- + +.. automodule:: outline.util + :members: + diff --git a/docs/modules/outline.versions.rst b/docs/modules/outline.versions.rst new file mode 100644 index 000000000..67d57bfad --- /dev/null +++ b/docs/modules/outline.versions.rst @@ -0,0 +1,24 @@ +outline.versions package +======================== + +Module contents +--------------- + +.. automodule:: outline.versions + :members: + +Submodules +---------- + +outline.versions.main module +---------------------------- + +.. automodule:: outline.versions.main + :members: + +outline.versions.session module +------------------------------- + +.. automodule:: outline.versions.session + :members: +