From 9453185734a6eebc0366a1712dfd54c033dfb95d Mon Sep 17 00:00:00 2001 From: Akihiro Motoki Date: Sun, 29 Mar 2020 05:16:15 +0900 Subject: [PATCH] Drop sphinx document We don't provide any sphinx documents as we cover horizon specific topics in the horizon repository. The current version is just from the cookiecutter and is never maintained since created. README and CONTRIBUTING.rst would be enough. Change-Id: I60c6e64e771f4e6bd3482a4d6a2a37228dde98b9 --- .gitignore | 3 -- doc/source/conf.py | 75 ------------------------------------- doc/source/contributing.rst | 4 -- doc/source/index.rst | 25 ------------- doc/source/installation.rst | 12 ------ doc/source/readme.rst | 1 - doc/source/usage.rst | 7 ---- setup.cfg | 8 ---- test-requirements.txt | 2 - tox.ini | 4 -- 10 files changed, 141 deletions(-) delete mode 100755 doc/source/conf.py delete mode 100644 doc/source/contributing.rst delete mode 100644 doc/source/index.rst delete mode 100644 doc/source/installation.rst delete mode 100644 doc/source/readme.rst delete mode 100644 doc/source/usage.rst diff --git a/.gitignore b/.gitignore index 7c527a4..eb3ed82 100644 --- a/.gitignore +++ b/.gitignore @@ -41,9 +41,6 @@ nosetests.xml output/*.html output/*/index.html -# Sphinx -doc/build - # pbr generates these AUTHORS ChangeLog diff --git a/doc/source/conf.py b/doc/source/conf.py deleted file mode 100755 index 6bb53de..0000000 --- a/doc/source/conf.py +++ /dev/null @@ -1,75 +0,0 @@ -# -*- 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 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', - 'oslosphinx' -] - -# 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'tempest_ec2' -copyright = u'2013, OpenStack Foundation' - -# 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 -------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. Major themes that come with -# Sphinx are currently 'default' and 'sphinxdoc'. -# html_theme_path = ["."] -# html_theme = '_theme' -# html_static_path = ['static'] - -# Output file base name for HTML help builder. -htmlhelp_basename = '%sdoc' % project - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass -# [howto/manual]). -latex_documents = [ - ('index', - '%s.tex' % project, - u'%s Documentation' % project, - u'OpenStack Foundation', 'manual'), -] - -# Example configuration for intersphinx: refer to the Python standard library. -#intersphinx_mapping = {'http://docs.python.org/': None} diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst deleted file mode 100644 index 1728a61..0000000 --- a/doc/source/contributing.rst +++ /dev/null @@ -1,4 +0,0 @@ -============ -Contributing -============ -.. include:: ../../CONTRIBUTING.rst diff --git a/doc/source/index.rst b/doc/source/index.rst deleted file mode 100644 index e1ae6fd..0000000 --- a/doc/source/index.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. tempest-horizon documentation master file, created by - sphinx-quickstart on Tue Jul 9 22:26:36 2013. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to tempest-horizon's documentation! -======================================================== - -Contents: - -.. toctree:: - :maxdepth: 2 - - readme - installation - usage - contributing - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - diff --git a/doc/source/installation.rst b/doc/source/installation.rst deleted file mode 100644 index e3a3eef..0000000 --- a/doc/source/installation.rst +++ /dev/null @@ -1,12 +0,0 @@ -============ -Installation -============ - -At the command line:: - - $ pip install tempest-horizon - -Or, if you have virtualenvwrapper installed:: - - $ mkvirtualenv tempest-horizon - $ pip install tempest-horizon diff --git a/doc/source/readme.rst b/doc/source/readme.rst deleted file mode 100644 index a6210d3..0000000 --- a/doc/source/readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../README.rst diff --git a/doc/source/usage.rst b/doc/source/usage.rst deleted file mode 100644 index b24203d..0000000 --- a/doc/source/usage.rst +++ /dev/null @@ -1,7 +0,0 @@ -======== -Usage -======== - -To use tempest-horizon in a project:: - - import tempest-horizon diff --git a/setup.cfg b/setup.cfg index 21fd965..88a6eab 100644 --- a/setup.cfg +++ b/setup.cfg @@ -26,14 +26,6 @@ packages = tempest.test_plugins = horizon = tempest_horizon.plugin:HorizonTempestPlugin -[build_sphinx] -source-dir = doc/source -build-dir = doc/build -all_files = 1 - -[upload_sphinx] -upload-dir = doc/build/html - [compile_catalog] directory = tempest_horizon/locale domain = tempest_horizon diff --git a/test-requirements.txt b/test-requirements.txt index b986009..c3fccfd 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -5,7 +5,5 @@ hacking>=2.0,<2.1 # Apache-2.0 coverage!=4.4,>=4.0 # Apache-2.0 -oslosphinx>=4.7.0 # Apache-2.0 python-subunit>=1.0.0 # Apache-2.0/BSD -sphinx>=1.6.2 # BSD stestr>=2.0.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index 79c0eec..07d2365 100644 --- a/tox.ini +++ b/tox.ini @@ -30,10 +30,6 @@ commands = coverage html -d cover coverage xml -o cover/coverage.xml -[testenv:docs] -basepython = python3 -commands = python setup.py build_sphinx - [testenv:debug] basepython = python3 commands = oslo_debug_helper {posargs}