Skip to content

Commit

Permalink
Stop using sphinx-plantuml and just inline uml diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
amoeba committed Feb 20, 2018
1 parent a98d5b3 commit d1d688d
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 21 deletions.
3 changes: 1 addition & 2 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,7 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx.ext.intersphinx',
'sphinx.ext.githubpages',
'sphinxcontrib.plantuml']
'sphinx.ext.githubpages']

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand Down
19 changes: 1 addition & 18 deletions mockups/tale-publishing/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -178,24 +178,7 @@ TODO: Do we implement the API as a single call, or many calls for each item? We
Sequence Diagram
~~~~~~~~~~~~~~~~

.. uml::

@startuml diag
User -> Dashboard: Clicks "Publish"
activate Dashboard
Dashboard -> Backend: req saveTale(id)
activate Backend
loop each item
Backend -> Repository: createObject
Repository --> Backend: objectCreated
end
Backend -> Repository: req createPackage
Repository --> Backend: resp packageCreated
Backend --> Dashboard: resp taleSaved(id)
deactivate Backend
Dashboard --> User: Updates UI
deactivate Dashboard
@enduml
.. image:: images/sequence-diagram.png

Terms:

Expand Down
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 18 additions & 0 deletions mockups/tale-publishing/src/sequence-diagram.plantuml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
.. uml::

@startuml diag
User -> Dashboard: Clicks "Publish"
activate Dashboard
Dashboard -> Backend: req saveTale(id)
activate Backend
loop each item
Backend -> Repository: createObject
Repository --> Backend: objectCreated
end
Backend -> Repository: req createPackage
Repository --> Backend: resp packageCreated
Backend --> Dashboard: resp taleSaved(id)
deactivate Backend
Dashboard --> User: Updates UI
deactivate Dashboard
@enduml
1 change: 0 additions & 1 deletion requirements.txt

This file was deleted.

0 comments on commit d1d688d

Please sign in to comment.