Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversion of Sphinx based tutorial to markdown/mkdocs #204

Merged
merged 6 commits into from
May 27, 2021
Merged

Conversion of Sphinx based tutorial to markdown/mkdocs #204

merged 6 commits into from
May 27, 2021

Conversation

neteler
Copy link
Member

@neteler neteler commented May 26, 2021

This PR

  • adds the .rst files converted with pandoc to MD into the docs/ subdir
  • adds mkdocs.yml (the site style may be updated later; default for now)
  • contains manual code style fixes after pandoc conversion

Can be locally build with

mkdocs build

The static site is then written to site/ with index.html etc.

Fixes #181

TODO

  • verify content, layout, and update accordingly

Example

image

Copy link
Member

@marcjansen marcjansen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good so far.

@anikaweinmann anikaweinmann added the documentation related to all kinds of docs (API docs, website, ...) label May 27, 2021
Copy link
Member

@mmacata mmacata left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great! Please also replace the command in the Makefile with mkdocs build
Then fine for me to be merged.

@neteler neteler merged commit 587b64c into actinia-org:main May 27, 2021
@neteler neteler deleted the mkdocs_tutorial branch May 27, 2021 09:49
@neteler neteler changed the title WIP: Conversion of Sphinx based tutorial to markdown/mkdocs Conversion of Sphinx based tutorial to markdown/mkdocs May 27, 2021
@mmacata mmacata added this to the 1.0.0 milestone Jun 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation related to all kinds of docs (API docs, website, ...)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Transform documentation
4 participants