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

[WIP] Create new wiki system #82

Closed
6 tasks done
simonmicro opened this issue Jul 26, 2020 · 4 comments
Closed
6 tasks done

[WIP] Create new wiki system #82

simonmicro opened this issue Jul 26, 2020 · 4 comments

Comments

@simonmicro
Copy link
Contributor

simonmicro commented Jul 26, 2020

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

  • New wiki
  • Reshoot screenshots with english terminal
  • Convert html tables to markdown tables, so the generated PDF handbook can display them
  • Merge docker/README.md into the docs
  • Add note about Dockerfiles after Docker multiarch #93
  • Add contribution section
@simonmicro
Copy link
Contributor Author

@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
Copy link
Owner

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
Copy link
Contributor Author

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

@simonmicro
Copy link
Contributor Author

This took me a while - but it now done!

Transmission ended.

edgd1er pushed a commit to edgd1er/py-kms that referenced this issue Apr 23, 2023
…/etrigan/remove

Remove Etrigan and add a new web-ui
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

No branches or pull requests

2 participants