Skip to content
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.

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

docs: update links #60

Merged
merged 1 commit into from
Feb 9, 2024
Merged
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
11 changes: 6 additions & 5 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@ protowhat

protowhat is a utility package required by

- `sqlwhat <https://sqlwhat.readthedocs.io>`_ to write SCTs for SQL exercises, and
- `protowhat <https://shellwhat.readthedocs.io>`_ to write SCTs for Shell exercises.
- `pythonwhat <https://pythonwhat.readthedocs.io>`_ to write SCTs for Python exercises
- `sqlwhat <https://sqlwhat.readthedocs.io>`_ to write SCTs for SQL exercises
- `shellwhat <https://shellwhat.readthedocs.io>`_ to write SCTs for Shell exercises

protowhat contains functionality that is shared between these packages, including:

Expand All @@ -13,11 +14,11 @@ protowhat contains functionality that is shared between these packages, includin
- AST element selection, dispatching and message generation,
- Basic SCT functions such as ``success_msg()`` and ``has_chosen()``.

All relevent documentation to write SCTs for SQL and Shell exercises,
including functions that reside in ``protowhat``, can be found in the `sqlwhat <https://sqlwhat.readthedocs.io>`_ and `protowhat <https://shellwhat.readthedocs.io>`_ documentation.
All relevent documentation to write SCTs for Python, SQL and Shell exercises,
including functions that reside in ``protowhat``, can be found in the `pythonwhat <https://pythonwhat.readthedocs.io>`_, `sqlwhat <https://sqlwhat.readthedocs.io>`_ and `shellwhat <https://shellwhat.readthedocs.io>`_ documentation.

.. toctree::
:maxdepth: 2
:caption: Reference

reference
reference