Skip to content

Add docs build and update descriptons#10

Merged
MJCliffe merged 4 commits into
MJCliffe:Livefrom
ml-evs:ml-evs/tweak_readme
Aug 24, 2023
Merged

Add docs build and update descriptons#10
MJCliffe merged 4 commits into
MJCliffe:Livefrom
ml-evs:ml-evs/tweak_readme

Conversation

@ml-evs
Copy link
Copy Markdown
Collaborator

@ml-evs ml-evs commented Aug 24, 2023

This PR adds a mkdocs-based build of the documentation, to be served alongside the app.

  • README updates: changing links and style, as well as some wording
  • Docstring updates to code to better support docs (including LaTeX equations: somehow puts the emphasis on the rendered docs over the docstrings but I think its nice for this case).
  • CI build of docs that should get deployed at least to the test server for now. Probably be available from {TEST_URL}/site/index.html initially, but we can move things around to be something more sensible. Not sure what Azure actually exposes yet

Some screenshots of the built docs:

image

image

@MJCliffe MJCliffe merged commit 9568142 into MJCliffe:Live Aug 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants