Skip to content

Commit

Permalink
add in the plantuml plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
pahjbo committed Mar 28, 2024
1 parent c031449 commit 45fc28f
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 11 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/site.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ jobs:
path: .cache
restore-keys: |
mkdocs-material-
- run: pip install mkdocs-material
- run: pip install mkdocs-material plantuml-markdown
- name: Deploy site
run: mkdocs gh-deploy --force
3 changes: 3 additions & 0 deletions docs/Developer/ProposalDM.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# ProposalDM

The underlying proposal data model is defined in a [separate project](https://ivoa.github.io/ProposalDM/).
10 changes: 3 additions & 7 deletions docs/Developer/api.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
+++
title = "Polaris REST API"
type = "swagger"
weight = 1
description = "Reference for the Polaris API"
+++
# API

A swagger Ui for the deployed api is available at https://kilburn.jb.man.ac.uk/pst/api/q/swagger-ui/

{{< swaggerui src="../../../openapi/openapi.yaml" >}}
6 changes: 3 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ nav:
- Reference:
- Use Cases: Developer/use-cases.md
- Architecture: Developer/architecture.md
- Data Model: Developer/ProposalDM.md
- API: Developer/api.md
- Deployment:
- Getting Started: Deployment/index.md
Expand All @@ -39,9 +40,8 @@ theme:
markdown_extensions:
- tables
- footnotes
# TODO add this once https://github.com/mikitex70/plantuml-markdown/pull/94 has been done
# - plantuml_markdown:
# server: https://www.plantuml.com/plantuml # PlantUML server, for remote rendering
- plantuml_markdown:
server: https://www.plantuml.com/plantuml # PlantUML server, for remote rendering
- pymdownx.superfences:
custom_fences:
- name: mermaid
Expand Down

0 comments on commit 45fc28f

Please sign in to comment.