Browse Source

generate separate index files for each api-ref

currntly, no index.html file is generated for any of the APIs,
which should be required to migrate over to the api-site.

check the generated build.

Change-Id: Ib290c7412ff426b3061c5ad7535c8cb8310500fa
changes/63/337363/1
Steve Martinelli 6 years ago
parent
commit
4f183727f1
  1. 2
      api-ref/source/conf.py
  2. 50
      api-ref/source/index.inc
  3. 27
      api-ref/source/index.rst
  4. 12
      api-ref/source/v2-admin/index.rst
  5. 10
      api-ref/source/v2-ext/index.rst
  6. 11
      api-ref/source/v2/index.rst
  7. 11
      api-ref/source/v3-ext/index.rst
  8. 20
      api-ref/source/v3/index.rst

2
api-ref/source/conf.py

@ -49,7 +49,7 @@ extensions = [
# templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.inc'
source_suffix = '.rst'
# The encoding of source files.
# source_encoding = 'utf-8'

50
api-ref/source/index.inc

@ -1,50 +0,0 @@
.. keystone documentation master file, created by
sphinx-quickstart on Mon May 23 07:54:13 2016.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to keystone's documentation!
====================================
Contents:
.. toctree::
:maxdepth: 2
v2-admin/admin-tenants.inc
v2-admin/admin-tokens.inc
v2-admin/admin-users.inc
v2-admin/admin-versions.inc
v2/identity-api-extensions.inc
v2/identity-auth.inc
v2/versions.inc
v2-ext/ksadm-admin.inc
v2-ext/ksec2-admin.inc
v3/authenticate-v3.inc
v3/credentials
v3/domains
v3/domains-config-v3
v3/groups
v3/identity_v3_OS-OAUTH1
v3/policies
v3/projects
v3/regions-v3
v3/roles
v3/service-catalog
v3/users
v3-ext/identity_v3_OS-ENDPOINT-POLICY-ext.inc
v3-ext/inherit.inc
v3-ext/trust.inc
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

27
api-ref/source/index.rst

@ -0,0 +1,27 @@
.. keystone documentation master file, created by
sphinx-quickstart on Mon May 23 07:54:13 2016.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to keystone's documentation!
====================================
Contents:
.. toctree::
:maxdepth: 1
v2/index
v2-admin/index
v2-ext/index
v3/index
v3-ext/index
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

12
api-ref/source/v2-admin/index.rst

@ -0,0 +1,12 @@
:tocdepth: 2
=====================================
Identity Admin API v2.0 (SUPPORTED)
=====================================
.. rest_expand_all::
.. include:: admin-tenants.inc
.. include:: admin-tokens.inc
.. include:: admin-users.inc
.. include:: admin-versions.inc

10
api-ref/source/v2-ext/index.rst

@ -0,0 +1,10 @@
:tocdepth: 2
==========================================
Identity API v2.0 extensions (SUPPORTED)
==========================================
.. rest_expand_all::
.. include:: ksadm-admin.inc
.. include:: ksec2-admin.inc

11
api-ref/source/v2/index.rst

@ -0,0 +1,11 @@
:tocdepth: 2
===============================
Identity API v2.0 (SUPPORTED)
===============================
.. rest_expand_all::
.. include:: identity-api-extensions.inc
.. include:: identity-auth.inc
.. include:: versions.inc

11
api-ref/source/v3-ext/index.rst

@ -0,0 +1,11 @@
:tocdepth: 2
======================================
Identity API v3 extensions (CURRENT)
======================================
.. rest_expand_all::
.. include:: identity_v3_OS-ENDPOINT-POLICY-ext.inc
.. include:: inherit.inc
.. include:: trust.inc

20
api-ref/source/v3/index.rst

@ -0,0 +1,20 @@
:tocdepth: 2
===========================
Identity API v3 (CURRENT)
===========================
.. rest_expand_all::
.. include:: authenticate-v3.inc
.. include:: credentials.inc
.. include:: domains.inc
.. include:: domains-config-v3.inc
.. include:: groups.inc
.. include:: identity_v3_OS-OAUTH1.inc
.. include:: policies.inc
.. include:: projects.inc
.. include:: regions-v3.inc
.. include:: roles.inc
.. include:: service-catalog.inc
.. include:: users.inc
Loading…
Cancel
Save