From f596e6f3e0cee022b3d56673e67da0d9a371da25 Mon Sep 17 00:00:00 2001 From: "S.Lott" Date: Sun, 25 May 2025 18:49:55 -0400 Subject: [PATCH 1/2] Update documentation to make API a little easier to find --- docs/index.html | 9 +++++++++ docs/source/api.rst | 4 +++- docs/source/index.rst | 14 +++++++++++--- docs/source/integration.rst | 2 ++ docs/source/structure.rst | 2 ++ 5 files changed, 27 insertions(+), 4 deletions(-) create mode 100644 docs/index.html diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..e6beca0 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,9 @@ + + + + + + + Cel-Python Docs + + diff --git a/docs/source/api.rst b/docs/source/api.rst index 774fd98..da47f98 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -2,11 +2,13 @@ # Copyright 2020 The Cloud Custodian Authors. # SPDX-License-Identifier: Apache-2.0 +.. _`api`: + ########### CEL-Py API ########### -Details of the CEL-Python implementation. +Details of the CEL-Python implementation and the API to the various components. .. automodule:: celpy.__init__ diff --git a/docs/source/index.rst b/docs/source/index.rst index a4271ca..1e548d7 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -23,7 +23,15 @@ Pure Python implementation of Google Common Expression Language, https://opensou - Protocols: expressions are a useful data type and require interoperability across programming languages and platforms. This implementation has minimal dependencies, runs quickly, and can be embedded into Python-based applications. -Specifically, the intent is to be part of Cloud Custodian, C7N, as part of the security policy filter. +Specifically, one intent is to be part of Cloud Custodian (C7N) as part of the security policy filter. + +Interested in the API? There are three interesting topics: + +- :ref:`integration` +- :ref:`api` +- :ref:`data_structures` + +The integration into another application isn't a trivial ``import``. .. toctree:: :maxdepth: 2 @@ -31,10 +39,10 @@ Specifically, the intent is to be part of Cloud Custodian, C7N, as part of the s installation cli - integration configuration - structure + integration api + structure c7n_functions diff --git a/docs/source/integration.rst b/docs/source/integration.rst index 6332f91..86ef221 100644 --- a/docs/source/integration.rst +++ b/docs/source/integration.rst @@ -2,6 +2,8 @@ # Copyright 2020 The Cloud Custodian Authors. # SPDX-License-Identifier: Apache-2.0 +.. _`integration`: + ######################## Application Integration ######################## diff --git a/docs/source/structure.rst b/docs/source/structure.rst index aeeca7a..b2ee74c 100644 --- a/docs/source/structure.rst +++ b/docs/source/structure.rst @@ -2,6 +2,8 @@ # Copyright 2020 The Cloud Custodian Authors. # SPDX-License-Identifier: Apache-2.0 +.. _`data_structures`: + ############### Data Structures ############### From a6b097fbd3c23ef35ec37a613dec46ba85b988e6 Mon Sep 17 00:00:00 2001 From: "S.Lott" Date: Sun, 25 May 2025 19:18:27 -0400 Subject: [PATCH 2/2] Update .gitignore --- .gitignore | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 5462dcc..574ee12 100644 --- a/.gitignore +++ b/.gitignore @@ -69,7 +69,8 @@ instance/ .scrapy # Sphinx documentation -docs/_build/ +docs/doctrees/ + # PyBuilder target/