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.

Sign up for GitHub

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

Jump to bottom

Move documentation #60

Closed
JakubTesarek opened this issue May 31, 2019 · 1 comment
Closed

Move documentation #60

JakubTesarek opened this issue May 31, 2019 · 1 comment
Assignees
@JakubTesarek
Labels
documentation Errors or missing information in docs

Comments

@JakubTesarek
Copy link
Owner

Documentation in single README file is getting cluttered. Move it to better place.

Alternatives:

  • Github wiki/pages
    • Same place as repository
    • Markdown format
  • Read the docs
    • Versioning
@JakubTesarek JakubTesarek added the code quality Doesn't add feature but improves the code label May 31, 2019
@JakubTesarek
Copy link
Owner Author

https://www.quora.com/A-Python-projects-use-of-Sphinx-vs-a-GitHub-wiki

@JakubTesarek JakubTesarek added documentation Errors or missing information in docs and removed code quality Doesn't add feature but improves the code labels Jun 1, 2019
@JakubTesarek JakubTesarek self-assigned this Jun 3, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JakubTesarek JakubTesarek

Labels
documentation Errors or missing information in docs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@JakubTesarek