eager-dev / eager

[deprecated] Engine Agnostic Gym Environment for Robotics
https://eager-control.readthedocs.io/
Apache License 2.0
16 stars 0 forks source link

Initial work on docs #151

Closed AlexanderKeijzer closed 3 years ago

AlexanderKeijzer commented 3 years ago

This is the initial work on the documentation. It is probably a good idea to merge this asap and expand on this together.

To locally build the documentation you need to install sphinx, sphinx_autodoc_typehints and sphinx-rtd-theme in pip/conda and run make html in the docs folder. Once the repo goes public we should be able to publish these docs with readthedocs.io with a couple of clicks.

Screenshot from 2021-06-25 12-24-51

bheijden commented 3 years ago

I'm getting an error when running make html. What python version are you using to build? It seems I am using python 2.7, but perhaps I should use python 3?

Running Sphinx v1.8.5

Exception occurred:
  File "/home/bas/.local/lib/python2.7/site-packages/sphinx/registry.py", line 472, in load_extension
    mod = __import__(extname, None, None, ['setup'])
  File "/home/bas/.local/lib/python2.7/site-packages/sphinx_autodoc_typehints.py", line 16
    def unwrap(func, *, stop=None):
                      ^
SyntaxError: invalid syntax
The full traceback has been saved in /tmp/sphinx-err-ggFBOJ.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!
Makefile:20: recipe for target 'html' failed
make: *** [html] Error 2
AlexanderKeijzer commented 3 years ago

Yes, I am running python 3 for this. It is needed to support the typehints.