Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dmdu authored Jul 31, 2024
1 parent 40b21c5 commit 521f484
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,12 @@ Interactive HTML page with API documentation is produced using apiDoc. It can be
```
apidoc -i . -o docs/ -t apidoc-template
```
The output can be seen by opening `docs/index.html` in a browser. The flask app is configured to serve this documentation page (and related files) at "/" (i.e., "home") route.
The output can be seen by opening `docs/index.html` in a browser. The flask app is configured to serve this documentation page (and related files) at the "/api" route.

For installing apiDoc on osx, run:
```
brew install apidoc
```

### More about the Project

Expand Down

0 comments on commit 521f484

Please sign in to comment.