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

Move documention to readthedocs.io #35

Closed
rcnijzink opened this issue Jul 16, 2019 · 2 comments
Closed

Move documention to readthedocs.io #35

rcnijzink opened this issue Jul 16, 2019 · 2 comments

Comments

@rcnijzink
Copy link
Contributor

Documentation of the VOM is now in a separate folder in html-format, better to move in the future to: https://docs.readthedocs.io/

@schymans
Copy link
Owner

Here is a nice collection of tools to help conversion from html to markdown: http://www.cantoni.org/2013/01/19/converting-html-to-text-markdown
Pandoc seemed to work alright, but manual clean-up is still necessary. The advantage of readthedocs.io is that it can be easily viewed online and it can be automated. The advantage of the current html-based documentation is that it can be easily browsed on the local computer. Could we have the best of both?

@rcnijzink
Copy link
Contributor Author

Also this is included (#45), so I guess it can be closed.

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