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

Create a documentation compatible to ReadTheDocs #97

Closed
zodman opened this issue May 21, 2020 · 3 comments
Closed

Create a documentation compatible to ReadTheDocs #97

zodman opened this issue May 21, 2020 · 3 comments

Comments

@zodman
Copy link
Member

zodman commented May 21, 2020

Related to the issue #81 missing task

We had the documentation on the README.md, create the documentation on readmethedocs it is necessary?

@camilonova @aleksihakli

@camilonova
Copy link
Member

I agree is not necessary. We can just use the README.md file

@zodman
Copy link
Member Author

zodman commented May 21, 2020

I agree too, it is enough the readme... @aleksihakli ? If you agree, I think we can close the #81

@aleksihakli
Copy link
Member

I think README.md is good for this project. If the documentation expands or we wish to generate something from the source code then RTD is a good option, but using it to just display a README that is displayed on GitHub as well is a bit of an overkill.

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

3 participants