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

Fill out ReadTheDocs page/Generated Docs #71

Open
1 of 8 tasks
DannyWeitekamp opened this issue Dec 7, 2020 · 1 comment
Open
1 of 8 tasks

Fill out ReadTheDocs page/Generated Docs #71

DannyWeitekamp opened this issue Dec 7, 2020 · 1 comment

Comments

@DannyWeitekamp
Copy link
Collaborator

DannyWeitekamp commented Dec 7, 2020

We need a read the docs (or similar style) page. That has:

  • Installation instructions
  • Descriptions of the agent API
  • Descriptions of each agent
  • Descriptions of each planner
  • Descriptions of at least Operator implementations we plan on using going forward
  • Descriptions of each learning mechanism type
  • Descriptions of each learning mechanism implementation
  • Descriptions of useful internal utilities like StateMultiView

There seems to be some start to auto documenting AL, but I don't know if this has reach the point of actually generating a document.
Update: yes it has started but needs to be filled out

@eharpste
Copy link
Member

eharpste commented Dec 7, 2020

We have auto generating docs for each repo already: https://al-core.readthedocs.io/en/latest/ The install instructions are lifted straight from the repo's README. We can start putting doc comments in code for the functional API docs but if you want things outside of that we need to make individual rst files and add them to the toc.

@DannyWeitekamp DannyWeitekamp changed the title ReadTheDocs page + Documentation Generation Fill out ReadTheDocs page/Generated Docs Dec 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants