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

Project documentation/wiki with sphinx #4

Open
8 tasks
Jarthianur opened this issue Apr 18, 2020 · 0 comments
Open
8 tasks

Project documentation/wiki with sphinx #4

Jarthianur opened this issue Apr 18, 2020 · 0 comments
Labels
component: docs documentation Improvements or additions to documentation nice to have
Projects
docs

Comments

@Jarthianur
Copy link
Owner

This project needs a documentation/wiki about how to use, extend etc.
The doc should be created within docs/ folder and created with sphinx.

Subtasks:

  • create doc base layout with sphinx
  • layout and idea behind this project, and how it works
  • components:
    • builder-tool installation and usage
    • modules and how they work
  • how to define an application
  • how to extend/create modules
  • how to build and run an application
@Jarthianur Jarthianur added documentation Improvements or additions to documentation v1.0.0 component: docs labels Apr 18, 2020
@Jarthianur Jarthianur added this to the 1.0.0 milestone Apr 18, 2020
@Jarthianur Jarthianur self-assigned this Apr 18, 2020
@Jarthianur Jarthianur added this to To do in docs via automation Apr 18, 2020
@Jarthianur Jarthianur removed their assignment Apr 18, 2020
@Jarthianur Jarthianur removed this from the 1.0.0 milestone Nov 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
component: docs documentation Improvements or additions to documentation nice to have
Projects
docs
  
To do
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Jarthianur