Skip to content

Nachtfeuer/engine

Repository files navigation

engine

An "engine" for math

Build Status Documentation Coverage Status BCH compliance codebeat badge Known Vulnerabilities DeepSource

Using mkdocs

pip install mkdocs pymdown-extensions plantuml-markdown
mkdocs build
mkdocs serve

If mkdocs serve does not work:

python -m http.server

API Documentation

pip install pdoc3
pdoc --html -ohtml.docmentation engine

After this open html.documentation/engine/index.html in your browser. As an alternative you can do following:

pdoc --http localhost:8000 engine

View http://localhost:8000 in your browser to see the API documentation. You might have to use another port if that one is in use.

Links