I get a “404 Not Found” error when I follow the ReadTheDocs link at the very end of README.md. Is this a typo in the URL or does the documentation not yet exist on ReadTheDocs?
But I was able to create the ReadTheDocs locally as follows:
$ cd docs
$ pip install sphinx
$ pip install sphinx-rtd-theme
$ make html
Some warnings and errors were reported during the creation. I was then able to view the documentation starting from docs/_build/html/index.html.
Maybe we should provide instructions for creating the documentation locally on the README.md for now, at least as long as the documentation is not yet public on ReadTheDocs.
I have refactored the documentation for mkdocs, which is easier and nicer. Still needs some work, but it will replace the RTD and will go public next week.
I get a “404 Not Found” error when I follow the ReadTheDocs link at the very end of README.md. Is this a typo in the URL or does the documentation not yet exist on ReadTheDocs?
But I was able to create the ReadTheDocs locally as follows:
Some warnings and errors were reported during the creation. I was then able to view the documentation starting from
docs/_build/html/index.html
.Maybe we should provide instructions for creating the documentation locally on the README.md for now, at least as long as the documentation is not yet public on ReadTheDocs.