diff --git a/.gitignore b/.gitignore index 7b94bc5291..37f85b618e 100644 --- a/.gitignore +++ b/.gitignore @@ -7,6 +7,7 @@ target/ /publish-docs/ /www/output/ /generated/ +/doc/playground-user-guide/build-admin/ build/ /build-*.log.gz diff --git a/doc/playground-user-guide/source/cli.rst b/doc/playground-user-guide/source/cli.rst index a7ffc734b4..88480fee71 100644 --- a/doc/playground-user-guide/source/cli.rst +++ b/doc/playground-user-guide/source/cli.rst @@ -91,4 +91,5 @@ service with its package name and description. cli_manage_instances_hosts.rst cli_provide_user_data_to_instances.rst cli_set_quotas.rst - + manage_projects_users_and_roles.rst + nova_cli_manage_projects_security.rst diff --git a/doc/playground-user-guide/source/nova_cli_manage_projects_security.rst b/doc/playground-user-guide/source/nova_cli_manage_projects_security.rst index 3dbf78c995..44ff0208a7 100644 --- a/doc/playground-user-guide/source/nova_cli_manage_projects_security.rst +++ b/doc/playground-user-guide/source/nova_cli_manage_projects_security.rst @@ -1,5 +1,5 @@ .. meta:: - :scope: admin_only + :scope: admin_only ======================= Manage project security diff --git a/doc/playground-user-guide/sphinx-ext/scope.py b/doc/playground-user-guide/sphinx-ext/scope.py index 64cc93d7b9..02327f6b0a 100644 --- a/doc/playground-user-guide/sphinx-ext/scope.py +++ b/doc/playground-user-guide/sphinx-ext/scope.py @@ -49,7 +49,10 @@ def env_get_outdated(app, env, added, changed, removed): def doctree_read(app, doctree): for toctreenode in doctree.traverse(addnodes.toctree): + to_remove = [] for e in toctreenode['entries']: ref = str(e[1]) if ref in docs_for_admin: - toctreenode['entries'].remove(e) + to_remove.append(e) + for e in to_remove: + toctreenode['entries'].remove(e) diff --git a/tox.ini b/tox.ini index 878b3981a5..b003161191 100644 --- a/tox.ini +++ b/tox.ini @@ -37,26 +37,33 @@ commands = commands = openstack-doc-test --check-deletions {posargs} [testenv:checkbuild] -# Build first the www pages so that openstack-doc-test creates a link to -# www/www-index.html. commands = + # Build first the www pages so that openstack-doc-test creates a link to + # www/www-index.html. mkdir -p publish-docs/www python tools/www-generator.py --source-directory www/ --output-directory publish-docs/www/ cp www/www-index.html publish-docs/ rsync -a www/static/ publish-docs/www/ - sphinx-build -W doc/playground-user-guide/source/ doc/playground-user-guide/build/html + # Build RST playground-user-guide + sphinx-build -E -W doc/playground-user-guide/source/ doc/playground-user-guide/build/html mkdir -p publish-docs/playground-user-guide/content/ rsync -a doc/playground-user-guide/build/html/ publish-docs/playground-user-guide/content/ - sphinx-build -W doc/networking-guide/source doc/networking-guide/build/html + # Build RST user-guide-admincontent + sphinx-build -t admin_only -E -W doc/playground-user-guide/source/ doc/playground-user-guide/build-admin/html + mkdir -p publish-docs/playground-user-guide-admin/content/ + rsync -a doc/playground-user-guide/build-admin/html/ publish-docs/playground-user-guide-admin/content/ + # Build RST networking guide + sphinx-build -E -W doc/networking-guide/source doc/networking-guide/build/html mkdir -p publish-docs/networking-guide/content/ rsync -a doc/networking-guide/build/html/ publish-docs/networking-guide/content/ - # Do not build DocBook XML Networking Guide + # Build DocBook Guides, note we do not build the DocBook XML Networking Guide openstack-doc-test --check-build --ignore-book networking-guide {posargs} [testenv:docs] commands = - sphinx-build -W doc/playground-user-guide/source/ doc/playground-user-guide/build/html - sphinx-build -W doc/networking-guide/source doc/networking-guide/build/html + sphinx-build -E -W doc/playground-user-guide/source/ doc/playground-user-guide/build/html + sphinx-build -t admin_only -E -W doc/playground-user-guide/source/ doc/playground-user-guide/build-admin/html + sphinx-build -E -W doc/networking-guide/source doc/networking-guide/build/html [testenv:network] commands = sphinx-build -W doc/networking-guide/source doc/networking-guide/build/html