Rename api.rst to rest_api.rst #241 #445

* Add rest_api.rst and installation.rst to their respective toctrees Signed-off-by: Jono Yang <[email protected]>
aboutcode-org · Jun 3, 2024 · 3cf2904 · 3cf2904
1 parent dd9d8ed
commit 3cf2904
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 1 deletion.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -4,6 +4,10 @@ Changelog
 Next Release
 ----------------
 
+- The API endpoints for ``approximate_directory_content_index``,
+  ``approximate_directory_structure_index``, ``exact_file_index``,
+  ``exact_package_archive_index``, ``cditems``, ``on_demand_queue`` have been
+  removed.
 
 v5.0.0
 ---------
@@ -14,7 +18,7 @@ v5.0.0
 - Support indexing of PURLs listed in https://github.com/nexB/purldb/issues/326,
   https://github.com/nexB/purldb/issues/327, https://github.com/nexB/purldb/issues/328,
   https://github.com/nexB/purldb/issues/329 and https://github.com/nexB/purldb/issues/356.
-- Support ``addon_pipelines`` for symbol and string collection in ``/api/collect`` endpoint. https://github.com/nexB/purldb/pull/393 
+- Support ``addon_pipelines`` for symbol and string collection in ``/api/collect`` endpoint. https://github.com/nexB/purldb/pull/393
 - Store ``source_symbols`` and ``source_strings`` in ``extra_data`` field. https://github.com/nexB/purldb/pull/351
 
 

diff --git a/docs/source/how-to-guides/index.rst b/docs/source/how-to-guides/index.rst
@@ -7,5 +7,6 @@ through specific use cases:
 .. toctree::
    :maxdepth: 2
 
+   installation
    matchcode
    tutorial_symbol_and_string_collection
diff --git a/docs/source/purldb/index.rst b/docs/source/purldb/index.rst
@@ -6,3 +6,4 @@ PURLdb
 
    overview
    symbol_and_string_collection
+   rest_api
diff --git a/docs/source/purldb/api.rst → docs/source/purldb/rest_api.rst b/docs/source/purldb/api.rst → docs/source/purldb/rest_api.rst