From f6ce6bd3282b09e6376d0c9313d05346f99acfb5 Mon Sep 17 00:00:00 2001 From: KATO Tomoyuki Date: Wed, 10 Feb 2016 21:11:33 +0900 Subject: [PATCH] Rename common-rst to common Keep the sync target repo path "common-rst" as of now. Change-Id: I552d2c0a422c4824632b11fa273629004b889306 --- doc-tools-check-languages.conf | 5 ++-- doc/admin-guide-cloud/source/common | 2 +- doc/arch-design-draft/source/common | 2 +- doc/arch-design/source/common | 2 +- doc/cli-reference/source/common | 2 +- doc/{common-rst => common}/app_support.rst | 0 ...i_discover_version_number_for_a_client.rst | 0 ...install_openstack_command_line_clients.rst | 0 .../cli_manage_images.rst | 0 .../cli_manage_volumes.rst | 0 doc/{common-rst => common}/cli_overview.rst | 0 ...vironment_variables_using_openstack_rc.rst | 0 doc/{common-rst => common}/conventions.rst | 0 .../dashboard_customizing.rst | 0 .../figures/SCH_5002_V00_NUAC-Keystone.png | Bin .../figures/SCH_5002_V00_NUAC-Keystone.svg | 0 .../figures/dashboard_admin_tab.png | Bin .../figures/dashboard_identity_tab.png | Bin .../figures/dashboard_project_tab.png | Bin .../figures/dashboard_settings_tab.png | Bin .../figures/demo_multiple_dhcp_agents.png | Bin .../figures/horizon-screenshot.jpg | Bin .../openstack-arch-kilo-logical-v1.png | Bin .../openstack-arch-kilo-logical-v1.svg | 0 .../openstack_kilo_conceptual_arch.png | Bin .../openstack_kilo_conceptual_arch.svg | 0 .../get_started_block_storage.rst | 0 .../get_started_compute.rst | 0 .../get_started_conceptual_architecture.rst | 0 .../get_started_dashboard.rst | 0 .../get_started_database_service.rst | 0 .../get_started_feedback.rst | 0 .../get_started_file_storage.rst | 0 .../get_started_identity.rst | 0 .../get_started_image_service.rst | 0 .../get_started_logical_architecture.rst | 0 .../get_started_object_storage.rst | 0 .../get_started_openstack_networking.rst | 0 .../get_started_openstack_services.rst | 0 .../get_started_orchestration.rst | 0 .../get_started_sahara.rst | 0 .../get_started_storage_concepts.rst | 0 .../get_started_telemetry.rst | 0 .../get_started_with_openstack.rst | 0 .../log_in_dashboard.rst | 0 ...w_usage_statistics_for_hosts_instances.rst | 0 doc/{common-rst => common}/source/conf.py | 4 +-- .../source/locale/common.pot} | 0 .../source/locale/de/LC_MESSAGES/common.po} | 0 .../locale/en_GB/LC_MESSAGES/common.po} | 0 .../source/locale/es/LC_MESSAGES/common.po} | 0 .../source/locale/fr/LC_MESSAGES/common.po} | 0 .../source/locale/ja/LC_MESSAGES/common.po} | 0 .../source/locale/ru/LC_MESSAGES/common.po} | 0 .../locale/vi_VN/LC_MESSAGES/common.po} | 0 .../locale/zh_CN/LC_MESSAGES/common.po} | 0 doc/config-reference/source/common | 2 +- doc/contributor-guide/source/common | 2 +- doc/image-guide/source/common | 2 +- doc/install-guide/source/common | 2 +- doc/networking-guide/source/common | 2 +- doc/user-guide-admin/source/common | 2 +- doc/user-guide/source/common | 2 +- tools/build-install-guides-rst.sh | 2 +- tools/build-rst.sh | 2 +- tools/generatepot-rst.sh | 26 +++++++++--------- tools/sync-projects.sh | 4 +-- tox.ini | 8 +++--- 68 files changed, 36 insertions(+), 37 deletions(-) rename doc/{common-rst => common}/app_support.rst (100%) rename doc/{common-rst => common}/cli_discover_version_number_for_a_client.rst (100%) rename doc/{common-rst => common}/cli_install_openstack_command_line_clients.rst (100%) rename doc/{common-rst => common}/cli_manage_images.rst (100%) rename doc/{common-rst => common}/cli_manage_volumes.rst (100%) rename doc/{common-rst => common}/cli_overview.rst (100%) rename doc/{common-rst => common}/cli_set_environment_variables_using_openstack_rc.rst (100%) rename doc/{common-rst => common}/conventions.rst (100%) rename doc/{common-rst => common}/dashboard_customizing.rst (100%) rename doc/{common-rst => common}/figures/SCH_5002_V00_NUAC-Keystone.png (100%) rename doc/{common-rst => common}/figures/SCH_5002_V00_NUAC-Keystone.svg (100%) rename doc/{common-rst => common}/figures/dashboard_admin_tab.png (100%) rename doc/{common-rst => common}/figures/dashboard_identity_tab.png (100%) rename doc/{common-rst => common}/figures/dashboard_project_tab.png (100%) rename doc/{common-rst => common}/figures/dashboard_settings_tab.png (100%) rename doc/{common-rst => common}/figures/demo_multiple_dhcp_agents.png (100%) rename doc/{common-rst => common}/figures/horizon-screenshot.jpg (100%) rename doc/{common-rst => common}/figures/openstack-arch-kilo-logical-v1.png (100%) rename doc/{common-rst => common}/figures/openstack-arch-kilo-logical-v1.svg (100%) rename doc/{common-rst => common}/figures/openstack_kilo_conceptual_arch.png (100%) rename doc/{common-rst => common}/figures/openstack_kilo_conceptual_arch.svg (100%) rename doc/{common-rst => common}/get_started_block_storage.rst (100%) rename doc/{common-rst => common}/get_started_compute.rst (100%) rename doc/{common-rst => common}/get_started_conceptual_architecture.rst (100%) rename doc/{common-rst => common}/get_started_dashboard.rst (100%) rename doc/{common-rst => common}/get_started_database_service.rst (100%) rename doc/{common-rst => common}/get_started_feedback.rst (100%) rename doc/{common-rst => common}/get_started_file_storage.rst (100%) rename doc/{common-rst => common}/get_started_identity.rst (100%) rename doc/{common-rst => common}/get_started_image_service.rst (100%) rename doc/{common-rst => common}/get_started_logical_architecture.rst (100%) rename doc/{common-rst => common}/get_started_object_storage.rst (100%) rename doc/{common-rst => common}/get_started_openstack_networking.rst (100%) rename doc/{common-rst => common}/get_started_openstack_services.rst (100%) rename doc/{common-rst => common}/get_started_orchestration.rst (100%) rename doc/{common-rst => common}/get_started_sahara.rst (100%) rename doc/{common-rst => common}/get_started_storage_concepts.rst (100%) rename doc/{common-rst => common}/get_started_telemetry.rst (100%) rename doc/{common-rst => common}/get_started_with_openstack.rst (100%) rename doc/{common-rst => common}/log_in_dashboard.rst (100%) rename doc/{common-rst => common}/nova_show_usage_statistics_for_hosts_instances.rst (100%) rename doc/{common-rst => common}/source/conf.py (98%) rename doc/{common-rst/source/locale/common-rst.pot => common/source/locale/common.pot} (100%) rename doc/{common-rst/source/locale/de/LC_MESSAGES/common-rst.po => common/source/locale/de/LC_MESSAGES/common.po} (100%) rename doc/{common-rst/source/locale/en_GB/LC_MESSAGES/common-rst.po => common/source/locale/en_GB/LC_MESSAGES/common.po} (100%) rename doc/{common-rst/source/locale/es/LC_MESSAGES/common-rst.po => common/source/locale/es/LC_MESSAGES/common.po} (100%) rename doc/{common-rst/source/locale/fr/LC_MESSAGES/common-rst.po => common/source/locale/fr/LC_MESSAGES/common.po} (100%) rename doc/{common-rst/source/locale/ja/LC_MESSAGES/common-rst.po => common/source/locale/ja/LC_MESSAGES/common.po} (100%) rename doc/{common-rst/source/locale/ru/LC_MESSAGES/common-rst.po => common/source/locale/ru/LC_MESSAGES/common.po} (100%) rename doc/{common-rst/source/locale/vi_VN/LC_MESSAGES/common-rst.po => common/source/locale/vi_VN/LC_MESSAGES/common.po} (100%) rename doc/{common-rst/source/locale/zh_CN/LC_MESSAGES/common-rst.po => common/source/locale/zh_CN/LC_MESSAGES/common.po} (100%) diff --git a/doc-tools-check-languages.conf b/doc-tools-check-languages.conf index 701ade1810..4ed366783d 100644 --- a/doc-tools-check-languages.conf +++ b/doc-tools-check-languages.conf @@ -25,6 +25,8 @@ DOC_DIR="doc/" # Values need to match content in # project-config/jenkins/scripts/common_translation_update.sh declare -A SPECIAL_BOOKS=( + # This needs special handling, handle it with the RST tools. + ["common"]="RST" ["admin-guide-cloud"]="RST" ["arch-design"]="RST" ["config-reference"]="RST" @@ -35,10 +37,7 @@ declare -A SPECIAL_BOOKS=( ["user-guide-admin"]="RST" # Do not translate ["cli-reference"]="skip" - ["common"]="skip" ["contributor-guide"]="skip" # Skip arch design while its being revised ["arch-design-draft"]="skip" - # This needs special handling, handle it with the RST tools. - ["common-rst"]="RST" ) diff --git a/doc/admin-guide-cloud/source/common b/doc/admin-guide-cloud/source/common index 70c1930ee7..dc879abe93 120000 --- a/doc/admin-guide-cloud/source/common +++ b/doc/admin-guide-cloud/source/common @@ -1 +1 @@ -../../common-rst \ No newline at end of file +../../common \ No newline at end of file diff --git a/doc/arch-design-draft/source/common b/doc/arch-design-draft/source/common index 70c1930ee7..dc879abe93 120000 --- a/doc/arch-design-draft/source/common +++ b/doc/arch-design-draft/source/common @@ -1 +1 @@ -../../common-rst \ No newline at end of file +../../common \ No newline at end of file diff --git a/doc/arch-design/source/common b/doc/arch-design/source/common index 70c1930ee7..dc879abe93 120000 --- a/doc/arch-design/source/common +++ b/doc/arch-design/source/common @@ -1 +1 @@ -../../common-rst \ No newline at end of file +../../common \ No newline at end of file diff --git a/doc/cli-reference/source/common b/doc/cli-reference/source/common index 03b5b059b0..dc879abe93 120000 --- a/doc/cli-reference/source/common +++ b/doc/cli-reference/source/common @@ -1 +1 @@ -../../common-rst/ \ No newline at end of file +../../common \ No newline at end of file diff --git a/doc/common-rst/app_support.rst b/doc/common/app_support.rst similarity index 100% rename from doc/common-rst/app_support.rst rename to doc/common/app_support.rst diff --git a/doc/common-rst/cli_discover_version_number_for_a_client.rst b/doc/common/cli_discover_version_number_for_a_client.rst similarity index 100% rename from doc/common-rst/cli_discover_version_number_for_a_client.rst rename to doc/common/cli_discover_version_number_for_a_client.rst diff --git a/doc/common-rst/cli_install_openstack_command_line_clients.rst b/doc/common/cli_install_openstack_command_line_clients.rst similarity index 100% rename from doc/common-rst/cli_install_openstack_command_line_clients.rst rename to doc/common/cli_install_openstack_command_line_clients.rst diff --git a/doc/common-rst/cli_manage_images.rst b/doc/common/cli_manage_images.rst similarity index 100% rename from doc/common-rst/cli_manage_images.rst rename to doc/common/cli_manage_images.rst diff --git a/doc/common-rst/cli_manage_volumes.rst b/doc/common/cli_manage_volumes.rst similarity index 100% rename from doc/common-rst/cli_manage_volumes.rst rename to doc/common/cli_manage_volumes.rst diff --git a/doc/common-rst/cli_overview.rst b/doc/common/cli_overview.rst similarity index 100% rename from doc/common-rst/cli_overview.rst rename to doc/common/cli_overview.rst diff --git a/doc/common-rst/cli_set_environment_variables_using_openstack_rc.rst b/doc/common/cli_set_environment_variables_using_openstack_rc.rst similarity index 100% rename from doc/common-rst/cli_set_environment_variables_using_openstack_rc.rst rename to doc/common/cli_set_environment_variables_using_openstack_rc.rst diff --git a/doc/common-rst/conventions.rst b/doc/common/conventions.rst similarity index 100% rename from doc/common-rst/conventions.rst rename to doc/common/conventions.rst diff --git a/doc/common-rst/dashboard_customizing.rst b/doc/common/dashboard_customizing.rst similarity index 100% rename from doc/common-rst/dashboard_customizing.rst rename to doc/common/dashboard_customizing.rst diff --git a/doc/common-rst/figures/SCH_5002_V00_NUAC-Keystone.png b/doc/common/figures/SCH_5002_V00_NUAC-Keystone.png similarity index 100% rename from doc/common-rst/figures/SCH_5002_V00_NUAC-Keystone.png rename to doc/common/figures/SCH_5002_V00_NUAC-Keystone.png diff --git a/doc/common-rst/figures/SCH_5002_V00_NUAC-Keystone.svg b/doc/common/figures/SCH_5002_V00_NUAC-Keystone.svg similarity index 100% rename from doc/common-rst/figures/SCH_5002_V00_NUAC-Keystone.svg rename to doc/common/figures/SCH_5002_V00_NUAC-Keystone.svg diff --git a/doc/common-rst/figures/dashboard_admin_tab.png b/doc/common/figures/dashboard_admin_tab.png similarity index 100% rename from doc/common-rst/figures/dashboard_admin_tab.png rename to doc/common/figures/dashboard_admin_tab.png diff --git a/doc/common-rst/figures/dashboard_identity_tab.png b/doc/common/figures/dashboard_identity_tab.png similarity index 100% rename from doc/common-rst/figures/dashboard_identity_tab.png rename to doc/common/figures/dashboard_identity_tab.png diff --git a/doc/common-rst/figures/dashboard_project_tab.png b/doc/common/figures/dashboard_project_tab.png similarity index 100% rename from doc/common-rst/figures/dashboard_project_tab.png rename to doc/common/figures/dashboard_project_tab.png diff --git a/doc/common-rst/figures/dashboard_settings_tab.png b/doc/common/figures/dashboard_settings_tab.png similarity index 100% rename from doc/common-rst/figures/dashboard_settings_tab.png rename to doc/common/figures/dashboard_settings_tab.png diff --git a/doc/common-rst/figures/demo_multiple_dhcp_agents.png b/doc/common/figures/demo_multiple_dhcp_agents.png similarity index 100% rename from doc/common-rst/figures/demo_multiple_dhcp_agents.png rename to doc/common/figures/demo_multiple_dhcp_agents.png diff --git a/doc/common-rst/figures/horizon-screenshot.jpg b/doc/common/figures/horizon-screenshot.jpg similarity index 100% rename from doc/common-rst/figures/horizon-screenshot.jpg rename to doc/common/figures/horizon-screenshot.jpg diff --git a/doc/common-rst/figures/openstack-arch-kilo-logical-v1.png b/doc/common/figures/openstack-arch-kilo-logical-v1.png similarity index 100% rename from doc/common-rst/figures/openstack-arch-kilo-logical-v1.png rename to doc/common/figures/openstack-arch-kilo-logical-v1.png diff --git a/doc/common-rst/figures/openstack-arch-kilo-logical-v1.svg b/doc/common/figures/openstack-arch-kilo-logical-v1.svg similarity index 100% rename from doc/common-rst/figures/openstack-arch-kilo-logical-v1.svg rename to doc/common/figures/openstack-arch-kilo-logical-v1.svg diff --git a/doc/common-rst/figures/openstack_kilo_conceptual_arch.png b/doc/common/figures/openstack_kilo_conceptual_arch.png similarity index 100% rename from doc/common-rst/figures/openstack_kilo_conceptual_arch.png rename to doc/common/figures/openstack_kilo_conceptual_arch.png diff --git a/doc/common-rst/figures/openstack_kilo_conceptual_arch.svg b/doc/common/figures/openstack_kilo_conceptual_arch.svg similarity index 100% rename from doc/common-rst/figures/openstack_kilo_conceptual_arch.svg rename to doc/common/figures/openstack_kilo_conceptual_arch.svg diff --git a/doc/common-rst/get_started_block_storage.rst b/doc/common/get_started_block_storage.rst similarity index 100% rename from doc/common-rst/get_started_block_storage.rst rename to doc/common/get_started_block_storage.rst diff --git a/doc/common-rst/get_started_compute.rst b/doc/common/get_started_compute.rst similarity index 100% rename from doc/common-rst/get_started_compute.rst rename to doc/common/get_started_compute.rst diff --git a/doc/common-rst/get_started_conceptual_architecture.rst b/doc/common/get_started_conceptual_architecture.rst similarity index 100% rename from doc/common-rst/get_started_conceptual_architecture.rst rename to doc/common/get_started_conceptual_architecture.rst diff --git a/doc/common-rst/get_started_dashboard.rst b/doc/common/get_started_dashboard.rst similarity index 100% rename from doc/common-rst/get_started_dashboard.rst rename to doc/common/get_started_dashboard.rst diff --git a/doc/common-rst/get_started_database_service.rst b/doc/common/get_started_database_service.rst similarity index 100% rename from doc/common-rst/get_started_database_service.rst rename to doc/common/get_started_database_service.rst diff --git a/doc/common-rst/get_started_feedback.rst b/doc/common/get_started_feedback.rst similarity index 100% rename from doc/common-rst/get_started_feedback.rst rename to doc/common/get_started_feedback.rst diff --git a/doc/common-rst/get_started_file_storage.rst b/doc/common/get_started_file_storage.rst similarity index 100% rename from doc/common-rst/get_started_file_storage.rst rename to doc/common/get_started_file_storage.rst diff --git a/doc/common-rst/get_started_identity.rst b/doc/common/get_started_identity.rst similarity index 100% rename from doc/common-rst/get_started_identity.rst rename to doc/common/get_started_identity.rst diff --git a/doc/common-rst/get_started_image_service.rst b/doc/common/get_started_image_service.rst similarity index 100% rename from doc/common-rst/get_started_image_service.rst rename to doc/common/get_started_image_service.rst diff --git a/doc/common-rst/get_started_logical_architecture.rst b/doc/common/get_started_logical_architecture.rst similarity index 100% rename from doc/common-rst/get_started_logical_architecture.rst rename to doc/common/get_started_logical_architecture.rst diff --git a/doc/common-rst/get_started_object_storage.rst b/doc/common/get_started_object_storage.rst similarity index 100% rename from doc/common-rst/get_started_object_storage.rst rename to doc/common/get_started_object_storage.rst diff --git a/doc/common-rst/get_started_openstack_networking.rst b/doc/common/get_started_openstack_networking.rst similarity index 100% rename from doc/common-rst/get_started_openstack_networking.rst rename to doc/common/get_started_openstack_networking.rst diff --git a/doc/common-rst/get_started_openstack_services.rst b/doc/common/get_started_openstack_services.rst similarity index 100% rename from doc/common-rst/get_started_openstack_services.rst rename to doc/common/get_started_openstack_services.rst diff --git a/doc/common-rst/get_started_orchestration.rst b/doc/common/get_started_orchestration.rst similarity index 100% rename from doc/common-rst/get_started_orchestration.rst rename to doc/common/get_started_orchestration.rst diff --git a/doc/common-rst/get_started_sahara.rst b/doc/common/get_started_sahara.rst similarity index 100% rename from doc/common-rst/get_started_sahara.rst rename to doc/common/get_started_sahara.rst diff --git a/doc/common-rst/get_started_storage_concepts.rst b/doc/common/get_started_storage_concepts.rst similarity index 100% rename from doc/common-rst/get_started_storage_concepts.rst rename to doc/common/get_started_storage_concepts.rst diff --git a/doc/common-rst/get_started_telemetry.rst b/doc/common/get_started_telemetry.rst similarity index 100% rename from doc/common-rst/get_started_telemetry.rst rename to doc/common/get_started_telemetry.rst diff --git a/doc/common-rst/get_started_with_openstack.rst b/doc/common/get_started_with_openstack.rst similarity index 100% rename from doc/common-rst/get_started_with_openstack.rst rename to doc/common/get_started_with_openstack.rst diff --git a/doc/common-rst/log_in_dashboard.rst b/doc/common/log_in_dashboard.rst similarity index 100% rename from doc/common-rst/log_in_dashboard.rst rename to doc/common/log_in_dashboard.rst diff --git a/doc/common-rst/nova_show_usage_statistics_for_hosts_instances.rst b/doc/common/nova_show_usage_statistics_for_hosts_instances.rst similarity index 100% rename from doc/common-rst/nova_show_usage_statistics_for_hosts_instances.rst rename to doc/common/nova_show_usage_statistics_for_hosts_instances.rst diff --git a/doc/common-rst/source/conf.py b/doc/common/source/conf.py similarity index 98% rename from doc/common-rst/source/conf.py rename to doc/common/source/conf.py index fb960c6265..aa10e904bc 100644 --- a/doc/common-rst/source/conf.py +++ b/doc/common/source/conf.py @@ -56,7 +56,7 @@ master_doc = 'index' # General information about the project. project = u'Common documents' -bug_tag = u'common-rst' +bug_tag = u'common' copyright = u'2015-2016, OpenStack contributors' @@ -74,7 +74,7 @@ release = '1.0.0' # gitsha: The SHA checksum of the bug description. Automatically extracted from git log. # bug_tag: Tag for categorizing the bug. Must be set manually. # These variables are passed to the logabug code via html_context. -giturl = u'http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/common-rst/source' +giturl = u'http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/common/source' git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '" gitsha = os.popen(git_cmd).read().strip('\n') html_context = {"gitsha": gitsha, "bug_tag": bug_tag, diff --git a/doc/common-rst/source/locale/common-rst.pot b/doc/common/source/locale/common.pot similarity index 100% rename from doc/common-rst/source/locale/common-rst.pot rename to doc/common/source/locale/common.pot diff --git a/doc/common-rst/source/locale/de/LC_MESSAGES/common-rst.po b/doc/common/source/locale/de/LC_MESSAGES/common.po similarity index 100% rename from doc/common-rst/source/locale/de/LC_MESSAGES/common-rst.po rename to doc/common/source/locale/de/LC_MESSAGES/common.po diff --git a/doc/common-rst/source/locale/en_GB/LC_MESSAGES/common-rst.po b/doc/common/source/locale/en_GB/LC_MESSAGES/common.po similarity index 100% rename from doc/common-rst/source/locale/en_GB/LC_MESSAGES/common-rst.po rename to doc/common/source/locale/en_GB/LC_MESSAGES/common.po diff --git a/doc/common-rst/source/locale/es/LC_MESSAGES/common-rst.po b/doc/common/source/locale/es/LC_MESSAGES/common.po similarity index 100% rename from doc/common-rst/source/locale/es/LC_MESSAGES/common-rst.po rename to doc/common/source/locale/es/LC_MESSAGES/common.po diff --git a/doc/common-rst/source/locale/fr/LC_MESSAGES/common-rst.po b/doc/common/source/locale/fr/LC_MESSAGES/common.po similarity index 100% rename from doc/common-rst/source/locale/fr/LC_MESSAGES/common-rst.po rename to doc/common/source/locale/fr/LC_MESSAGES/common.po diff --git a/doc/common-rst/source/locale/ja/LC_MESSAGES/common-rst.po b/doc/common/source/locale/ja/LC_MESSAGES/common.po similarity index 100% rename from doc/common-rst/source/locale/ja/LC_MESSAGES/common-rst.po rename to doc/common/source/locale/ja/LC_MESSAGES/common.po diff --git a/doc/common-rst/source/locale/ru/LC_MESSAGES/common-rst.po b/doc/common/source/locale/ru/LC_MESSAGES/common.po similarity index 100% rename from doc/common-rst/source/locale/ru/LC_MESSAGES/common-rst.po rename to doc/common/source/locale/ru/LC_MESSAGES/common.po diff --git a/doc/common-rst/source/locale/vi_VN/LC_MESSAGES/common-rst.po b/doc/common/source/locale/vi_VN/LC_MESSAGES/common.po similarity index 100% rename from doc/common-rst/source/locale/vi_VN/LC_MESSAGES/common-rst.po rename to doc/common/source/locale/vi_VN/LC_MESSAGES/common.po diff --git a/doc/common-rst/source/locale/zh_CN/LC_MESSAGES/common-rst.po b/doc/common/source/locale/zh_CN/LC_MESSAGES/common.po similarity index 100% rename from doc/common-rst/source/locale/zh_CN/LC_MESSAGES/common-rst.po rename to doc/common/source/locale/zh_CN/LC_MESSAGES/common.po diff --git a/doc/config-reference/source/common b/doc/config-reference/source/common index 70c1930ee7..dc879abe93 120000 --- a/doc/config-reference/source/common +++ b/doc/config-reference/source/common @@ -1 +1 @@ -../../common-rst \ No newline at end of file +../../common \ No newline at end of file diff --git a/doc/contributor-guide/source/common b/doc/contributor-guide/source/common index 03b5b059b0..dc879abe93 120000 --- a/doc/contributor-guide/source/common +++ b/doc/contributor-guide/source/common @@ -1 +1 @@ -../../common-rst/ \ No newline at end of file +../../common \ No newline at end of file diff --git a/doc/image-guide/source/common b/doc/image-guide/source/common index 03b5b059b0..dc879abe93 120000 --- a/doc/image-guide/source/common +++ b/doc/image-guide/source/common @@ -1 +1 @@ -../../common-rst/ \ No newline at end of file +../../common \ No newline at end of file diff --git a/doc/install-guide/source/common b/doc/install-guide/source/common index 70c1930ee7..dc879abe93 120000 --- a/doc/install-guide/source/common +++ b/doc/install-guide/source/common @@ -1 +1 @@ -../../common-rst \ No newline at end of file +../../common \ No newline at end of file diff --git a/doc/networking-guide/source/common b/doc/networking-guide/source/common index 70c1930ee7..dc879abe93 120000 --- a/doc/networking-guide/source/common +++ b/doc/networking-guide/source/common @@ -1 +1 @@ -../../common-rst \ No newline at end of file +../../common \ No newline at end of file diff --git a/doc/user-guide-admin/source/common b/doc/user-guide-admin/source/common index 70c1930ee7..dc879abe93 120000 --- a/doc/user-guide-admin/source/common +++ b/doc/user-guide-admin/source/common @@ -1 +1 @@ -../../common-rst \ No newline at end of file +../../common \ No newline at end of file diff --git a/doc/user-guide/source/common b/doc/user-guide/source/common index 70c1930ee7..dc879abe93 120000 --- a/doc/user-guide/source/common +++ b/doc/user-guide/source/common @@ -1 +1 @@ -../../common-rst \ No newline at end of file +../../common \ No newline at end of file diff --git a/tools/build-install-guides-rst.sh b/tools/build-install-guides-rst.sh index 6eb226606d..684aa01a64 100755 --- a/tools/build-install-guides-rst.sh +++ b/tools/build-install-guides-rst.sh @@ -24,7 +24,7 @@ trap "mv -f ${INDEX}.save ${INDEX}" EXIT for tag in $TAGS; do GLOSSARY="" - if [[ ! -e doc/common-rst/glossary.rst ]] ; then + if [[ ! -e doc/common/glossary.rst ]] ; then GLOSSARY="--glossary" fi diff --git a/tools/build-rst.sh b/tools/build-rst.sh index e102b15567..7cec778582 100755 --- a/tools/build-rst.sh +++ b/tools/build-rst.sh @@ -67,7 +67,7 @@ done if [ "$GLOSSARY" -eq "1" ] ; then echo "Generating Glossary" - tools/glossary2rst.py doc/common-rst/glossary.rst + tools/glossary2rst.py doc/common/glossary.rst fi if [ -z "$BUILD" ] ; then diff --git a/tools/generatepot-rst.sh b/tools/generatepot-rst.sh index acfca0ba45..8a6acbfaab 100755 --- a/tools/generatepot-rst.sh +++ b/tools/generatepot-rst.sh @@ -35,16 +35,16 @@ else NUMBER_OF_CORES=2 fi -# common-rst is imported from various RST documents, but what files are +# common is imported from various RST documents, but what files are # used varies across RST documents. Thus we need an index file to include -# all files under common-rst. To this aim, we create such document called -# 'common-rst-work' dynamically to generate the POT file of common-rst. -if [[ "$REPOSITORY" = "openstack-manuals" && "$DOCNAME" = "common-rst" ]] ; then - DIRECTORY="doc/common-rst-work" +# all files under common. To this aim, we create such document called +# 'common-work' dynamically to generate the POT file of common. +if [[ "$REPOSITORY" = "openstack-manuals" && "$DOCNAME" = "common" ]] ; then + DIRECTORY="doc/common-work" TOPDIR="doc/" mkdir -p $DIRECTORY/source - cp doc/common-rst/source/conf.py $DIRECTORY/source/conf.py - ln -sf ../../common-rst $DIRECTORY/source/common + cp doc/common/source/conf.py $DIRECTORY/source/conf.py + ln -sf ../../common $DIRECTORY/source/common cat < $DIRECTORY/source/index.rst .. toctree:: :maxdepth: 2 @@ -56,7 +56,7 @@ fi if [ "$REPOSITORY" = "openstack-manuals" ] ; then # Build Glossary - tools/glossary2rst.py doc/common-rst/glossary.rst + tools/glossary2rst.py doc/common/glossary.rst fi # First remove the old pot file, otherwise the new file will contain # old references @@ -74,16 +74,16 @@ fi sphinx-build -j $NUMBER_OF_CORES -b gettext $TAG ${DIRECTORY}/source/ \ ${DIRECTORY}/source/locale/ -if [[ "$REPOSITORY" = "openstack-manuals" && "$DOCNAME" = "common-rst" ]] ; then - # In case of common-rst, we use the working directory 'common-rst-work'. - # Copies the generated POT to common-rst/source/locale +if [[ "$REPOSITORY" = "openstack-manuals" && "$DOCNAME" = "common" ]] ; then + # In case of common, we use the working directory 'common-work'. + # Copies the generated POT to common/source/locale # and finally removes the working directory. msgcat ${DIRECTORY}/source/locale/common.pot | \ awk '$0 !~ /^\# [a-z0-9]+$/' \ - > ${TOPDIR}common-rst/source/locale/common-rst.pot + > ${TOPDIR}common/source/locale/common.pot rm -rf $DIRECTORY else - # common-rst is translated as part of openstack-manuals, do not + # common is translated as part of openstack-manuals, do not # include the file in the combined tree if it exists. rm -f ${DIRECTORY}/source/locale/common.pot # Take care of deleting all temporary files so that diff --git a/tools/sync-projects.sh b/tools/sync-projects.sh index e446ca9d6c..de0d243688 100755 --- a/tools/sync-projects.sh +++ b/tools/sync-projects.sh @@ -26,7 +26,7 @@ function copy_rst_trans { for lang in ja ; do TARGET=$PROJECT_DIR/$target/source/locale/$lang/LC_MESSAGES mkdir -p $TARGET - cp doc/common-rst/source/locale/$lang/LC_MESSAGES/common-rst.po \ + cp doc/common/source/locale/$lang/LC_MESSAGES/common.po \ $TARGET done (cd $PROJECT_DIR; git add $target/source/locale/) @@ -39,7 +39,7 @@ function copy_rst { tools/glossary2rst.py $PROJECT_DIR/$target/glossary.rst for filename in app_support.rst conventions.rst; do - cp doc/common-rst/$filename $PROJECT_DIR/$target + cp doc/common/$filename $PROJECT_DIR/$target done (cd $PROJECT_DIR; git add $target) } diff --git a/tox.ini b/tox.ini index 78bd0e657a..55a26c8524 100644 --- a/tox.ini +++ b/tox.ini @@ -90,7 +90,7 @@ commands = sitepackages=True whitelist_externals = doc-tools-check-languages commands = - {toxinidir}/tools/glossary2rst.py doc/common-rst/glossary.rst + {toxinidir}/tools/glossary2rst.py doc/common/glossary.rst doc-tools-check-languages doc-tools-check-languages.conf test all [testenv:buildlang] @@ -101,7 +101,7 @@ commands = sitepackages=True whitelist_externals = doc-tools-check-languages commands = - {toxinidir}/tools/glossary2rst.py doc/common-rst/glossary.rst + {toxinidir}/tools/glossary2rst.py doc/common/glossary.rst doc-tools-check-languages doc-tools-check-languages.conf test {posargs} [testenv:publishlang] @@ -111,7 +111,7 @@ commands = sitepackages=True whitelist_externals = doc-tools-check-languages commands = - {toxinidir}/tools/glossary2rst.py doc/common-rst/glossary.rst + {toxinidir}/tools/glossary2rst.py doc/common/glossary.rst doc-tools-check-languages doc-tools-check-languages.conf publish all [testenv:generatepot-rst] @@ -123,7 +123,7 @@ commands = {toxinidir}/tools/generatepot-rst.sh openstack-manuals 1 {posargs} # Settings for doc8: # Ignore target directories # TODO(samos123): remove sriov from ignore when fix for #1487302 is in doc8 -ignore-path = doc/*/target,doc/*/build*,doc/common-rst/glossary.rst,doc/networking-guide/source/adv-config-sriov.rst +ignore-path = doc/*/target,doc/*/build*,doc/common/glossary.rst,doc/networking-guide/source/adv-config-sriov.rst # File extensions to use extensions = .rst,.txt # Maximal line length should be 79 but we have some overlong lines.