Skip to content

Commit

Permalink
Switch cli and rest-spec back to rst
Browse files Browse the repository at this point in the history
They contain special directives which haven't been made to work yet.
  • Loading branch information
joeshannon committed Mar 8, 2024
1 parent 517e2ce commit 5ba5b41
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
8 changes: 4 additions & 4 deletions docs/reference/cli.md → docs/reference/cli.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Command-Line Interface
Command-Line Interface
======================

Full reference for the CLI:

```{eval-rst}

.. click:: blueapi.cli:main
:prog: blueapi
:prog: blueapi
:show-nested:
```
5 changes: 2 additions & 3 deletions docs/reference/rest-spec.md → docs/reference/rest-spec.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
# REST Specification
REST Specification
==================

Blueapi runs a FastAPI server through which the blueapi worker can be
interacted with. This page documents all possible endpoints of this
server.

```{eval-rst}
.. openapi:: ./openapi.yaml
```

0 comments on commit 5ba5b41

Please sign in to comment.