Skip to content
This repository was archived by the owner on Apr 15, 2024. It is now read-only.
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
6 changes: 1 addition & 5 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -52,15 +52,11 @@ stage:
git push
git checkout develop

docs:
cd docs && make build && cd -
# The resulting reference docs file is in docs/_build/html/index.html

docs.dev:
sphinx-build -b html -v docs docs/_build/

docs.multi:
sphinx-multiversion -v docs docs/_build/
MULTI_VERSION="true" sphinx-multiversion -v docs docs/_build/
cp docs/index.html docs/_build/

docs.package:
Expand Down
20 changes: 0 additions & 20 deletions docs/Makefile

This file was deleted.

2 changes: 1 addition & 1 deletion docs/_templates/versions.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{%- if current_version %}
{%- if current_version and MULTI_VERSION %}
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Other Versions</span>
Expand Down
1 change: 0 additions & 1 deletion docs/build.sh

This file was deleted.

5 changes: 5 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -225,3 +225,8 @@
smv_released_pattern = r'^refs/tags/.*$'

html_favicon = '_static/favicon.png'

if 'MULTI_VERSION' in os.environ:
# skip version template if metadata isn't available
MULTI_VERSION = os.environ['MULTI_VERSION']
html_context['MULTI_VERSION'] = MULTI_VERSION
27 changes: 26 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Cortex Python Reference
=======================

This reference guide describes the base API client library to integrate with Cortex Fabric.
This reference guide describes the base API client library to integrate with Cortex Fabric.
Refer to the `Cortex Fabric documentation <https://cognitivescale.github.io/cortex-fabric/>`_ for more info about how to use the library.

Cortex
Expand Down Expand Up @@ -113,3 +113,28 @@ Exceptions
:members:
.. autoclass:: cortex.exceptions.APIException
:members:

Related Projects
================================

Cortex Fabric
--------------

Cortex Fabric provides a collaborative platform for building, deploying, and managing trusted AI systems.

See the `Cortex Fabric documentation. <https://cognitivescale.github.io/cortex-fabric>`_

Cortex Python Builders
------------------------

The cortex-python-builders library is an add-on library for use with the base cortex-python library that helps with building actions and skills.

See the `Cortex Python Builders Reference documentation. <https://cognitivescale.github.io/cortex-python-builders>`_

Cortex Python Profiles
-------------------------

The cortex-python-profiles library is an add-on for use with the base cortex-python library that helps with building and managing Profile-of-One profiles and schemas.

See the `Cortex Python Profiles Reference documentation. <https://cognitivescale.github.io/cortex-python-profiles>`_