Skip to content

#94: Moved the documentation from md to rst #95

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 40 commits into
base: main
Choose a base branch
from
Open

#94: Moved the documentation from md to rst #95

wants to merge 40 commits into from

Conversation

@ahsimb
Copy link
Collaborator

@ahsimb ahsimb commented Nov 14, 2025

closes #94

ahsimb added 30 commits August 24, 2025 09:59
@ahsimb
#43: Enhanced find_schemas and find_tables
f9ce52a
@ahsimb
Merge remote-tracking branch 'origin/main'
f21c538 
# Conflicts:
#	exasol/ai/mcp/server/meta_query.py
#	test/unit/test_meta_query.py
@ahsimb
Merge remote-tracking branch 'origin/main'
9de5e34
@ahsimb
Merge remote-tracking branch 'origin/main'
0903dd1
@ahsimb
Merge remote-tracking branch 'origin/main'
cc3b483
@ahsimb
Merge remote-tracking branch 'origin/main'
ca66bcc
@ahsimb
Merge remote-tracking branch 'origin/main'
c68781c
@ahsimb
Merge remote-tracking branch 'origin/main'
a09aca7
@ahsimb
Merge remote-tracking branch 'origin/main'
421d9c1
@ahsimb
Merge remote-tracking branch 'origin/main'
42c5317
@ahsimb
Merge remote-tracking branch 'origin/main'
d75ce42
@ahsimb
Merge remote-tracking branch 'origin/main'
dd4f856
@ahsimb
Merge remote-tracking branch 'origin/main'
cfcf56b
@ahsimb
Merge remote-tracking branch 'origin/main'
e8b82ad
@ahsimb
Merge remote-tracking branch 'origin/main'
f2b7115
@ahsimb
#70: Started the User Guide
946f7bc
@ahsimb
#70: doc checkpoint 1
b638baa
@ahsimb
#70: checkpoint 2
00446b8
@ahsimb
Merge remote-tracking branch 'origin/main' into documentation/70-user…
f6c0b1f 
…-guide
@ahsimb
#70: finished the guide
e5c98bb
@ahsimb
#70: removed doc build
6b24442
@ahsimb
#70: removed doc build
a89d74d
@ahsimb
kick off CI
204202d
@ahsimb
#70: removed doc build
cf1193d
@ahsimb
#70: small change in db conn user guide
60c49ae
@ahsimb
#70: addressed review comments
e9df820
@ahsimb
Merge remote-tracking branch 'origin/main'
6b38ca1
@ahsimb
Merge remote-tracking branch 'origin/main'
e677ce8
@ahsimb
Merge remote-tracking branch 'origin/main'
a64bc87
@ahsimb
Merge remote-tracking branch 'origin/main'
96c42f1
ArBridgeman
ArBridgeman requested changes Nov 17, 2025
View reviewed changes
doc/user_guide/server_setup.rst Outdated

The environment variables can be divided into three groups.

* `OpenID settings <open_id_setup.rst>`__
Copy link
Contributor

@ArBridgeman ArBridgeman Nov 17, 2025

Choose a reason for hiding this comment

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

These internal references to the rst files must be replaced with cross-references.
https://www.sphinx-doc.org/en/master/usage/referencing.html#ref-role
When I click on the link in the generated HTML, this gives a 404.

Copy link
Collaborator Author

@ahsimb ahsimb Nov 17, 2025

Choose a reason for hiding this comment

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

Done

@ahsimb ahsimb temporarily deployed to manual-approval November 17, 2025 09:41 — with GitHub Actions Inactive
@ahsimb ahsimb temporarily deployed to manual-approval November 17, 2025 09:41 — with GitHub Actions Inactive
@ahsimb ahsimb temporarily deployed to manual-approval November 17, 2025 09:41 — with GitHub Actions Inactive
@ahsimb ahsimb temporarily deployed to manual-approval November 17, 2025 09:41 — with GitHub Actions Inactive
ArBridgeman
ArBridgeman reviewed Nov 17, 2025
View reviewed changes
doc/user_guide/db_connection_setup.rst Outdated

The MCP server can be deployed in two ways: locally or as a remote HTTP server.
In the latter case, the server works in the multiple-user mode, and its tools must be
protected with OAuth2 authorization. Please refer to [OpenID Setup](open_id_setup.md)
Copy link
Contributor

@ArBridgeman ArBridgeman Nov 17, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

in line 9:
[OpenId Setup]](open_id_setup.md)
should be replaced with
:doc:open_id_setup

Copy link
Collaborator Author

@ahsimb ahsimb Nov 17, 2025

Choose a reason for hiding this comment

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

Well spotted, thanks.

@ahsimb ahsimb temporarily deployed to manual-approval November 17, 2025 09:59 — with GitHub Actions Inactive
@ahsimb ahsimb temporarily deployed to manual-approval November 17, 2025 09:59 — with GitHub Actions Inactive
@ahsimb ahsimb temporarily deployed to manual-approval November 17, 2025 09:59 — with GitHub Actions Inactive
@ahsimb ahsimb deployed to manual-approval November 17, 2025 09:59 — with GitHub Actions Active
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ArBridgeman ArBridgeman ArBridgeman approved these changes

Assignees

@ahsimb ahsimb

Labels

documentation User guides, tutorials, specifications

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Move documentation to rst format and re-enable the doc build

3 participants

@ahsimb @ArBridgeman