diff --git a/README.rst b/README.rst index 074473000..41c511b7d 100644 --- a/README.rst +++ b/README.rst @@ -2,32 +2,21 @@ Team and repository tags ======================== -.. image:: https://governance.openstack.org/tc/badges/api-site.svg - :target: https://governance.openstack.org/tc/reference/tags/index.html - -.. Change things from this point on API-Site repository +++++++++++++++++++ -This repository contains API documentation for the OpenStack project. - -For details, see `OpenStack Documentation Contributor Guide -`_, -which includes these pages: - - * API Quick Start - * API Guide (in progress) - -In addition to these documents, this repository contains: - - * Landing page for developer.openstack.org: ``www`` +This repository contains the index page for +https://developer.openstack.org in the `www` directory. To complete code reviews in this repository, use the standard OpenStack Gerrit `workflow `_. For details, see `Gerrit Workflow `_. +This repository is in a frozen state, it will be fully retired once a +new home is found for the index page. + Prerequisites ============= @@ -48,13 +37,6 @@ To build an individual document, such as the API Guide:: The locally-built output files are found in a ``publish-docs`` directory. -Build and update API docs -========================= - -Refer to the `OpenStack Documentation Contributor Guide -`_ -for more information. - Run tests ========= @@ -63,13 +45,8 @@ install the Python tox package and run ``tox`` from the top-level directory. To run individual tests: - * ``tox -e linters`` - Niceness tests * ``tox -e checkbuild`` - Builds all of the documents in this repository -To run these tests, the Tox package uses the -`OpenStack doc tools package -`_. - Contribute ========== diff --git a/api-ref/README.rst b/api-ref/README.rst deleted file mode 100644 index 841eb79e8..000000000 --- a/api-ref/README.rst +++ /dev/null @@ -1,3 +0,0 @@ -All the content in the ``api-ref`` directory is migrated to the corresponding -project repository. Look for the api-ref directory in the ``openstack/`` -repository. diff --git a/bindep.txt b/bindep.txt index 2fe6e7c1d..8e0e16122 100644 --- a/bindep.txt +++ b/bindep.txt @@ -1,10 +1,6 @@ # This is a cross-platform list tracking distribution packages needed by tests; # see https://docs.openstack.org/infra/bindep/ for additional information. -gettext -graphviz -libjpeg-dev [platform:dpkg] -libjpeg-turbo-devel [platform:rpm] python-dev [platform:dpkg] python-devel [platform:rpm] zlib-devel [platform:rpm] diff --git a/test-requirements.txt b/test-requirements.txt index a72b8beaa..983ab4741 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -4,19 +4,13 @@ pbr>=2.0.0,!=2.1.0 # Apache-2.0 -openstack-doc-tools>=1.8.0 # Apache-2.0 -doc8 # Apache-2.0 -Pygments - sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD -openstackdocstheme>=1.18.1 # Apache-2.0 -nwdiag -sphinxcontrib-nwdiag +openstack-doc-tools>=1.8.0 # Apache-2.0 +Jinja2>=2.10 requests os-service-types - -# For translations -Babel>=2.3.4,!=2.4.0 # BSD +lxml!=3.7.0,>=3.4.1 # BSD +six>=1.10.0 # MIT diff --git a/tox.ini b/tox.ini index 2b4515ef9..c8b138b1e 100644 --- a/tox.ini +++ b/tox.ini @@ -1,6 +1,6 @@ [tox] minversion = 1.6 -envlist = linters,checkbuild +envlist = checkbuild skipsdist = True [testenv] @@ -17,10 +17,6 @@ whitelist_externals = [testenv:venv] commands = {posargs} -[testenv:linters] -commands = - doc8 api-quick-start - [testenv:checkbuild] basepython = python2 commands = @@ -37,12 +33,3 @@ commands = [testenv:docs] commands = {toxinidir}/tools/build-index.sh publish - -[doc8] -# Settings for doc8: -# Ignore target directories -ignore-path = common/ -# File extensions to use -extensions = .rst,.txt -# Ignore lines longer than 79 chars -ignore = D001