Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
396 changes: 0 additions & 396 deletions api/XDS_PROTOCOL.md

This file was deleted.

456 changes: 456 additions & 0 deletions api/xds_protocol.rst

Large diffs are not rendered by default.

7 changes: 7 additions & 0 deletions docs/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ else
fi

SCRIPT_DIR=$(dirname "$0")
API_DIR=$(dirname "$dir")/api
BUILD_DIR=build_docs
[[ -z "${DOCS_OUTPUT_DIR}" ]] && DOCS_OUTPUT_DIR=generated/docs
[[ -z "${GENERATED_RST_DIR}" ]] && GENERATED_RST_DIR=generated/rst
Expand Down Expand Up @@ -159,6 +160,12 @@ do
[ -n "${CPROFILE_ENABLED}" ] && cp -f bazel-bin/"${p}".profile "$(dirname "${DEST}")"
done

mkdir -p ${GENERATED_RST_DIR}/api-docs

cp -f $API_DIR/xds_protocol.rst "${GENERATED_RST_DIR}/api-docs/xds_protocol.rst"

rsync -rav $API_DIR/diagrams "${GENERATED_RST_DIR}/api-docs"

rsync -av "${SCRIPT_DIR}"/root/ "${SCRIPT_DIR}"/conf.py "${GENERATED_RST_DIR}"

sphinx-build -W --keep-going -b html "${GENERATED_RST_DIR}" "${DOCS_OUTPUT_DIR}"
11 changes: 11 additions & 0 deletions docs/root/api/api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. _api:

API
===

.. toctree::
:glob:
:maxdepth: 2

../api-v2/api
../api-docs/xds_protocol
2 changes: 1 addition & 1 deletion docs/root/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ Envoy documentation
configuration/configuration
operations/operations
extending/extending
api-v2/api
api/api
faq/overview
2 changes: 2 additions & 0 deletions docs/root/intro/arch_overview/cluster_manager.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ distribution.
* Cluster manager :ref:`configuration <config_cluster_manager>`.
* CDS :ref:`configuration <config_cluster_manager_cds>`.

.. _arch_overview_cluster_warming:

Cluster warming
---------------

Expand Down
1 change: 1 addition & 0 deletions docs/root/intro/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,4 @@ Introduction
getting_help
version_history
deprecated

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added this new line to be consistent with all other files