simonmicro commented 4 years ago

Mission

Port current wiki to readthedocs by using Sphinx and include it into the repo. Also extend it to demonstrate docker and include parts of the README (which is a little bit overfilled). Eventually restructure it (own section for keys, copy-paste for the windows commands...).

This issue will stay here until it is fully implemented to be referenced by PRs.

Any ideas / suggestions? Drop them in the comments!

Progress

[x] New wiki
[x] Reshoot screenshots with english terminal
[x] Convert html tables to markdown tables, so the generated PDF handbook can display them
[x] Merge docker/README.md into the docs
[x] Add note about Dockerfiles after #93
[x] Add contribution section

simonmicro commented 4 years ago

@SystemRage I am thinking about adding a "Contributing" section to the docs - could you give me a list of your preferred doc/code styling you used?

SystemRage commented 4 years ago

let's say... a) 8-space indentation without tabs. b) docstrings as this:

        """ This is single line docstring. """
        """ This is a
        """ multiline comment.

c) Wrap lines only if really long (it does not matter 79 chars PEP8) for the rest a bit as it comes :)

simonmicro commented 3 years ago

Just a little ping: This is still on my ToDo list and not abandoned. I'll work here again, when I have time...

simonmicro commented 3 years ago

This took me a while - but it now done!

Transmission ended.

SystemRage / py-kms

[WIP] Create new wiki system #82

Mission

Progress