Cleanup repo
Remove unused content, update README. Update requirements to what should be needed. Change-Id: I3acd294314ba05da29611f789d75ed9fc8b21faf
This commit is contained in:
parent
57ca6e1317
commit
f2f69c47ba
33
README.rst
33
README.rst
@ -2,32 +2,21 @@
|
|||||||
Team and repository tags
|
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
|
API-Site repository
|
||||||
+++++++++++++++++++
|
+++++++++++++++++++
|
||||||
|
|
||||||
This repository contains API documentation for the OpenStack project.
|
This repository contains the index page for
|
||||||
|
https://developer.openstack.org in the `www` directory.
|
||||||
For details, see `OpenStack Documentation Contributor Guide
|
|
||||||
<https://docs.openstack.org/doc-contrib-guide/index.html>`_,
|
|
||||||
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``
|
|
||||||
|
|
||||||
To complete code reviews in this repository, use the standard
|
To complete code reviews in this repository, use the standard
|
||||||
OpenStack Gerrit `workflow <https://review.opendev.org>`_.
|
OpenStack Gerrit `workflow <https://review.opendev.org>`_.
|
||||||
For details, see `Gerrit Workflow
|
For details, see `Gerrit Workflow
|
||||||
<https://docs.openstack.org/infra/manual/developers.html#development-workflow>`_.
|
<https://docs.openstack.org/infra/manual/developers.html#development-workflow>`_.
|
||||||
|
|
||||||
|
This repository is in a frozen state, it will be fully retired once a
|
||||||
|
new home is found for the index page.
|
||||||
|
|
||||||
Prerequisites
|
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.
|
The locally-built output files are found in a ``publish-docs`` directory.
|
||||||
|
|
||||||
Build and update API docs
|
|
||||||
=========================
|
|
||||||
|
|
||||||
Refer to the `OpenStack Documentation Contributor Guide
|
|
||||||
<https://docs.openstack.org/doc-contrib-guide/api-guides.html>`_
|
|
||||||
for more information.
|
|
||||||
|
|
||||||
Run tests
|
Run tests
|
||||||
=========
|
=========
|
||||||
|
|
||||||
@ -63,13 +45,8 @@ install the Python tox package and run ``tox`` from the top-level directory.
|
|||||||
|
|
||||||
To run individual tests:
|
To run individual tests:
|
||||||
|
|
||||||
* ``tox -e linters`` - Niceness tests
|
|
||||||
* ``tox -e checkbuild`` - Builds all of the documents in this repository
|
* ``tox -e checkbuild`` - Builds all of the documents in this repository
|
||||||
|
|
||||||
To run these tests, the Tox package uses the
|
|
||||||
`OpenStack doc tools package
|
|
||||||
<https://opendev.org/openstack/openstack-doc-tools>`_.
|
|
||||||
|
|
||||||
Contribute
|
Contribute
|
||||||
==========
|
==========
|
||||||
|
|
||||||
|
@ -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/<project>``
|
|
||||||
repository.
|
|
@ -1,10 +1,6 @@
|
|||||||
# This is a cross-platform list tracking distribution packages needed by tests;
|
# This is a cross-platform list tracking distribution packages needed by tests;
|
||||||
# see https://docs.openstack.org/infra/bindep/ for additional information.
|
# 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-dev [platform:dpkg]
|
||||||
python-devel [platform:rpm]
|
python-devel [platform:rpm]
|
||||||
zlib-devel [platform:rpm]
|
zlib-devel [platform:rpm]
|
||||||
|
@ -4,19 +4,13 @@
|
|||||||
|
|
||||||
pbr>=2.0.0,!=2.1.0 # Apache-2.0
|
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,<2.0.0;python_version=='2.7' # BSD
|
||||||
sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD
|
sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD
|
||||||
|
|
||||||
openstackdocstheme>=1.18.1 # Apache-2.0
|
openstack-doc-tools>=1.8.0 # Apache-2.0
|
||||||
nwdiag
|
Jinja2>=2.10
|
||||||
sphinxcontrib-nwdiag
|
|
||||||
|
|
||||||
requests
|
requests
|
||||||
os-service-types
|
os-service-types
|
||||||
|
lxml!=3.7.0,>=3.4.1 # BSD
|
||||||
# For translations
|
six>=1.10.0 # MIT
|
||||||
Babel>=2.3.4,!=2.4.0 # BSD
|
|
||||||
|
15
tox.ini
15
tox.ini
@ -1,6 +1,6 @@
|
|||||||
[tox]
|
[tox]
|
||||||
minversion = 1.6
|
minversion = 1.6
|
||||||
envlist = linters,checkbuild
|
envlist = checkbuild
|
||||||
skipsdist = True
|
skipsdist = True
|
||||||
|
|
||||||
[testenv]
|
[testenv]
|
||||||
@ -17,10 +17,6 @@ whitelist_externals =
|
|||||||
[testenv:venv]
|
[testenv:venv]
|
||||||
commands = {posargs}
|
commands = {posargs}
|
||||||
|
|
||||||
[testenv:linters]
|
|
||||||
commands =
|
|
||||||
doc8 api-quick-start
|
|
||||||
|
|
||||||
[testenv:checkbuild]
|
[testenv:checkbuild]
|
||||||
basepython = python2
|
basepython = python2
|
||||||
commands =
|
commands =
|
||||||
@ -37,12 +33,3 @@ commands =
|
|||||||
[testenv:docs]
|
[testenv:docs]
|
||||||
commands =
|
commands =
|
||||||
{toxinidir}/tools/build-index.sh publish
|
{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
|
|
||||||
|
Loading…
Reference in New Issue
Block a user