From b2487fbe4b8d4cfa3e4773c8a0a7ca11c74a8719 Mon Sep 17 00:00:00 2001 From: Alexander Mazuruk Date: Mon, 12 Feb 2018 13:47:15 +0100 Subject: [PATCH] Initialize Sphinx documentation html_static_path setting was manually commented out to silence a warning from Sphinx. doc/sphinx/make.bat generated by sphinx-quickstart was removed. Verify using doc/Makefile. Generated using docker image from previous commit: cd doc/ docker run --rm=true --user `id -u $USER`:`id -g $USER` -v $PWD:/doc \ --name=muxpi-doc-container -it -a stdin -a stdout muxpi-doc-image \ sphinx-quickstart --quiet --sep --project="MuxPi" --no-batchfile \ --author="Samsung Electronics Co., Ltd" -v 0.0.1 sphinx Change-Id: I8ee45d663b4c59af4b770a0b5bae431222b1c191 Signed-off-by: Alexander Mazuruk --- .gitignore | 2 + doc/Makefile | 17 ++++- doc/sphinx/Makefile | 20 ++++++ doc/sphinx/source/conf.py | 152 ++++++++++++++++++++++++++++++++++++++++++++ doc/sphinx/source/index.txt | 19 ++++++ 5 files changed, 207 insertions(+), 3 deletions(-) create mode 100644 .gitignore create mode 100644 doc/sphinx/Makefile create mode 100644 doc/sphinx/source/conf.py create mode 100644 doc/sphinx/source/index.txt diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..efc1007 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +#Sphinx build directory +doc/sphinx/build/ diff --git a/doc/Makefile b/doc/Makefile index bb3827d..b3f3ec5 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -1,16 +1,27 @@ +DOC_DIR = sphinx DOCKER_IMAGE = muxpi-doc-image DOCKER_CONTAINER = muxpi-doc-container DOCKER_CONTAINER_WORKDIR = /doc -.PHONY: all clean build-docker-image clean-docker +.PHONY: all clean build-doc-html build-docker-image clean-doc clean-docker -all: build-docker-image +all: build-doc-html -clean: clean-docker +clean: clean-doc clean-docker + +build-doc-html: build-docker-image + docker run --rm=true \ + --volume `pwd`:${DOCKER_CONTAINER_WORKDIR} \ + --user `id -u $$USER`:`id -g $$USER` \ + --name ${DOCKER_CONTAINER} ${DOCKER_IMAGE} \ + make -C ${DOC_DIR} html build-docker-image: docker build -t ${DOCKER_IMAGE} docker +clean-doc: + -rm -r ${DOC_DIR}/build + clean-docker: -docker rm ${DOCKER_CONTAINER} -docker rmi ${DOCKER_IMAGE} diff --git a/doc/sphinx/Makefile b/doc/sphinx/Makefile new file mode 100644 index 0000000..e932534 --- /dev/null +++ b/doc/sphinx/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = MuxPi +SOURCEDIR = source +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/doc/sphinx/source/conf.py b/doc/sphinx/source/conf.py new file mode 100644 index 0000000..c00f83f --- /dev/null +++ b/doc/sphinx/source/conf.py @@ -0,0 +1,152 @@ +# -*- coding: utf-8 -*- +# Copyright (c) 2017 Samsung Electronics Co., Ltd All Rights Reserved +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License + +# -- Project information ----------------------------------------------------- + +project = 'MuxPi' +copyright = '2018, Samsung Electronics Co., Ltd' +author = 'Samsung Electronics Co., Ltd' + +# The short X.Y version +version = '0.0' +# The full version, including alpha/beta/rc tags +release = '0.0.1' + + +# -- 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 = '.txt' + +# 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 = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + + +# -- 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 = 'MuxPidoc' + + +# -- 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, 'MuxPi.tex', 'MuxPi Documentation', + 'Samsung Electronics Co., Ltd', '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, 'muxpi', 'MuxPi 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, 'MuxPi', 'MuxPi Documentation', + author, 'MuxPi', 'One line description of project.', + 'Miscellaneous'), +] diff --git a/doc/sphinx/source/index.txt b/doc/sphinx/source/index.txt new file mode 100644 index 0000000..0f4fab9 --- /dev/null +++ b/doc/sphinx/source/index.txt @@ -0,0 +1,19 @@ +.. MuxPi documentation master file, created by + sphinx-quickstart on Mon Aug 20 15:26:48 2018. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to MuxPi's documentation! +================================= + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`search` -- 2.7.4