ls1intum / Apollon

UML Modeling Editor written in React
https://apollon-library.readthedocs.io
MIT License
65 stars 22 forks source link

`Documentation`: Update documentation of Apollon #283

Closed minrows closed 1 year ago

minrows commented 1 year ago

Motivation and Context

The current documentation of Apollon, found here, is outdated and hence needs an update.

Description

This PR simply updates the documentation of Apollon.

Steps for Testing

In local machine

  1. Clone the repo and checkout to the documentation/update-documentation branch.
  2. Goto docs/ folder and install all the python dependencies by executing pip install -r requirements.txt
  3. Finally execute make singlehtml command
  4. Goto docs/build/singlehtml folder and open index.html in your browser.
  5. Observe the updated documentation.

From Artifact

You can also test the documentation from the latest build here.

PS: For more information regarding building the documentation, please refer to Artemis Documentation.