From 61d5e6c9ee32241d617afaeb8c6d02086e67e1be Mon Sep 17 00:00:00 2001 From: ricolin Date: Mon, 17 Feb 2020 13:07:27 +0800 Subject: [PATCH] Initial Sphinx structure Change-Id: I3f680ea7e78ef38c32791ee70426d5de100d899a Story: 2007257 Task: 38618 --- .gitignore | 36 ++++++++++++++ .zuul.yaml | 3 ++ LICENSE | 3 ++ MANIFEST.in | 6 +++ README.rst | 25 ++++++++++ doc/source/conf.py | 82 ++++++++++++++++++++++++++++++++ doc/source/index.rst | 30 ++++++++++++ doc/source/meta/CONTRIBUTING.rst | 79 ++++++++++++++++++++++++++++++ doc/source/spelling_wordlist.txt | 0 requirements.txt | 3 ++ setup.cfg | 24 ++++++++++ setup.py | 21 ++++++++ test-requirements.txt | 0 tox.ini | 26 ++++++++++ 14 files changed, 338 insertions(+) create mode 100644 .gitignore create mode 100644 .zuul.yaml create mode 100644 LICENSE create mode 100644 MANIFEST.in create mode 100644 README.rst create mode 100644 doc/source/conf.py create mode 100644 doc/source/index.rst create mode 100644 doc/source/meta/CONTRIBUTING.rst create mode 100644 doc/source/spelling_wordlist.txt create mode 100644 requirements.txt create mode 100644 setup.cfg create mode 100644 setup.py create mode 100644 test-requirements.txt create mode 100644 tox.ini diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..fd16e16 --- /dev/null +++ b/.gitignore @@ -0,0 +1,36 @@ +*.py[cod] + +# Packages +*.egg +*.egg-info +dist +build +eggs +parts +sdist +develop-eggs +.installed.cfg + +# Installer logs +pip-log.txt + +# Unit test / coverage reports +.tox +nosetests.xml +.testrepository + +# Mr Developer +.mr.developer.cfg +.project +.pydevproject + +# Sphinx +doc/build + +# pbr generates these +AUTHORS +ChangeLog + +# Editors +*~ +.*.swp diff --git a/.zuul.yaml b/.zuul.yaml new file mode 100644 index 0000000..7909506 --- /dev/null +++ b/.zuul.yaml @@ -0,0 +1,3 @@ +- project: + templates: + - publish-openstack-docs-pti diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..75a29c4 --- /dev/null +++ b/LICENSE @@ -0,0 +1,3 @@ +This work is licensed under a Creative Commons Attribution 3.0 Unported License. + +http://creativecommons.org/licenses/by/3.0/legalcode diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..c978a52 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,6 @@ +include AUTHORS +include ChangeLog +exclude .gitignore +exclude .gitreview + +global-exclude *.pyc diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..e840ab8 --- /dev/null +++ b/README.rst @@ -0,0 +1,25 @@ +========================== +OpenStack Multi-Arch SIG +========================== + +This repository is for storing documentation and code which relates to +the initiatives of OpenStack's Multi-Arch SIG. + +For other information and resources regarding the +SIG, please see `the SIG's etherpad page +`_. + +The documentation in this repository is automatically published +online in HTML format: + +- https://docs.openstack.org/multi-arch-sig/latest/ + +License +------- + +Except for where stated otherwise: + +* Any specs, use-cases, and other documentation are released under + a `Creative Commons Attribution license `_. +* Any code is released under `the Apache License 2.0 + `_. diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 0000000..366b611 --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,82 @@ +# -*- coding: utf-8 -*- +# 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. + +import datetime +import os +import sys + +sys.path.insert(0, os.path.abspath('../..')) +# -- General configuration ---------------------------------------------------- + +# 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', + 'openstackdocstheme', + 'yasfb', +] + +html_theme = 'openstackdocs' + +# openstackdocstheme options +repository_name = 'openstack/multi-arch-sig' +bug_project = '917' +bug_tag = '' + +# Feed configuration for yasfb +feed_base_url = 'http://specs.openstack.org/openstack/multi-arch-sig' +feed_author = 'OpenStack Multi-Arch SIG' + +exclude_patterns = [ + 'specs/template.rst', + 'use-cases/template.rst', +] + +# Optionally allow the use of sphinxcontrib.spelling to verify the +# spelling of the documents. +try: + import sphinxcontrib.spelling + extensions.append('sphinxcontrib.spelling') +except ImportError: + pass + +# autodoc generation is a bit aggressive and a nuisance when doing heavy +# text edit cycles. +# execute "export SPHINX_DEBUG=1" in your terminal to disable + +# The suffix of source filenames. +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Multi-Arch SIG' +copyright = u'%s, OpenStack Foundation' % datetime.date.today().year + +# 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 = True + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# -- Options for HTML output -------------------------------------------------- + +# Example configuration for intersphinx: refer to the Python standard library. +#intersphinx_mapping = {'http://docs.python.org/': None} diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..12432de --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,30 @@ +========================== +OpenStack Multi-Arch SIG +========================== + +This documentation relates to some of the initiatives of OpenStack's +Multi-Arch SIG (Special Interest Group). For more information on +the SIG itself, see the SIG's `etherpad +`_ and `StoryBoard +`_. + +Contributions to this documentation are warmly encouraged; please see +:doc:`the guide to contributing `. + + +.. toctree:: + :maxdepth: 2 + +Links for Multi-Arch SIG +========================== + +* `StoryBoard `_ +* `Repository `_ +* `Gerrit `_ +* `Meeting `_ +* IRC: #openstack-multi-arch + +Indices and tables +================== + +* :ref:`search` diff --git a/doc/source/meta/CONTRIBUTING.rst b/doc/source/meta/CONTRIBUTING.rst new file mode 100644 index 0000000..23fcd9f --- /dev/null +++ b/doc/source/meta/CONTRIBUTING.rst @@ -0,0 +1,79 @@ +:orphan: + +============================================= +Contributing to OpenStack's Multi-Arch SIG +============================================= + +If you would like to participate in discussions or contribute in any +way to the design and development of Multi-Arch in OpenStack, please +first see the following etherpad to understand the SIG's mission, scope, +and other supporting information: + + https://etherpad.openstack.org/p/Multi-arch + +Many forms of contribution are valuable to the community, including but not +limited to the following: + +- `Documentation`, including implementation details if available +- `Code` +- `Discussions` on all the above and other topics + +Everyone is warmly encouraged to get involved in whatever capacity you +see fit. + +Discussions +----------- + +Discussions take place: + +- on `the openstack-discuss mailing list + `_ + with ``[Multi-Arch-sig]`` in the Subject header, +- `the SIG's storyboard + `_, +- `Meeting _` +- `IRC channel '#openstack-multi-arch' + _` +- and in `patch reviews + _`. + +Links to all resources can also be found in the `SIG etherpad`_. + +.. _`SIG etherpad`: https://etherpad.openstack.org/p/Multi-arch + +Use cases +--------- + +The SIG serves to facilitate the discussion and documentation of Multi-Arch +use cases at all stages of development from a seed idea to a fully tested use +case. + +To call attention to a use case, please start the discussion in `one +of the established communication channels <#discussions>`_. + +See `Submitting a change`_ for more information. + +Code +---- + +The Multi-Arch-sig repository also holds any relevant +cross-project code, tests, and documentation that do not naturally +belong in a single project repository. + +See `Submitting a change`_ for more information. + +Submitting a change +------------------- + +To submit a change to this repository, please follow the steps in this page: + + http://docs.openstack.org/infra/manual/developers.html + +If you already have a good understanding of how the system works and your +OpenStack accounts are set up, you can skip to the development workflow +section of this documentation to learn how changes to OpenStack should be +submitted for review via the Gerrit tool: + + http://docs.openstack.org/infra/manual/developers.html#development-workflow + +Pull requests submitted through GitHub will be ignored. diff --git a/doc/source/spelling_wordlist.txt b/doc/source/spelling_wordlist.txt new file mode 100644 index 0000000..e69de29 diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..3d69233 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +pbr>=2.0.0 +openstackdocstheme +yasfb>=0.5.1 diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..9c43d62 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,24 @@ +[metadata] +name = Multi-Arch-sig +summary = This repository is for storing documentation and code which relates to the initiatives of OpenStack's Multi-Arch SIG +description-file = + README.rst +author = OpenStack +author-email = openstack-discuss@lists.openstack.org +home-page = https://docs.openstack.org/multi-arch-sig/latest/ +classifier = + Environment :: OpenStack + Intended Audience :: Developers + License :: OSI Approved :: Apache Software License + Operating System :: POSIX :: Linux + +[build_sphinx] +source-dir = doc/source +build-dir = doc/build +all_files = 1 + +[pbr] +warnerrors = True + +[upload_sphinx] +upload-dir = doc/build/html diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..04db36c --- /dev/null +++ b/setup.py @@ -0,0 +1,21 @@ +#!/usr/bin/env python +# +# 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. + +# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT +import setuptools + +setuptools.setup( + setup_requires=['pbr'], + pbr=True) diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 0000000..e69de29 diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..26ce7ce --- /dev/null +++ b/tox.ini @@ -0,0 +1,26 @@ +[tox] +minversion = 1.6 +envlist = docs +skipsdist = True + +[testenv] +basepython = python3 +usedevelop = True +install_command = pip install -U {opts} {packages} +setenv = + VIRTUAL_ENV={envdir} +deps = -r{toxinidir}/requirements.txt + -r{toxinidir}/test-requirements.txt + +[testenv:venv] +commands = {posargs} + +[testenv:docs] +commands = sphinx-build -W -b html doc/source doc/build/html + +[testenv:spelling] +deps = + -r{toxinidir}/requirements.txt + sphinxcontrib-spelling + PyEnchant +commands = sphinx-build -b spelling doc/source doc/build/spelling