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

Implement Sphinx documentation #55

Closed
Diego635 opened this issue Jul 22, 2019 · 1 comment
Closed

Implement Sphinx documentation #55

Diego635 opened this issue Jul 22, 2019 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation wontfix This is not to be fixed. Just something to do (not urgent).
Milestone

Comments

@Diego635
Copy link
Collaborator

We need to use sphinx for the documentation. This is the tool that creates the html help page and maybe a pdf documentation too.
The help html should look like a Wikipedia page. I think that is the format sphinx creates anyway.
There should be one page where the whole workflow is explained, with different chapters/sections and links to it from the content section at the beginning ("Wikipedia" format).
Then there could be a second page with known issues / errors and the way to solve them.
A way to give feedback should be there too. A link to GitHub, an e-mail...

@Diego635 Diego635 added documentation Improvements or additions to documentation wontfix This is not to be fixed. Just something to do (not urgent). labels Jul 22, 2019
@Diego635 Diego635 added this to the Version 0.3 milestone Jul 23, 2019
@Diego635 Diego635 added wontfix This is not to be fixed. Just something to do (not urgent). and removed wontfix This is not to be fixed. Just something to do (not urgent). labels Jul 23, 2019
@jaminzoda
Copy link
Owner

Sphinx documentation of code is implemented in 43101d9. However, the automatic documentation does not deal with the help on how to use the tool. It is instead the API documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation wontfix This is not to be fixed. Just something to do (not urgent).
Projects
None yet
Development

No branches or pull requests

2 participants