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

Document interface #20

Open
zsunberg opened this issue Feb 10, 2021 · 3 comments
Open

Document interface #20

zsunberg opened this issue Feb 10, 2021 · 3 comments

Comments

@zsunberg
Copy link
Member

The interface should be documented very clearly. Currently, there is a list of functions in the readme, but that is not complete (it doesn't include stage for instance).

Probably the best way to do this is with Documenter.jl

@zsunberg zsunberg added this to the Package Registration milestone Feb 10, 2021
@Omastto1
Copy link
Member

I completed the initial version of the Documentation using Documenter.jl in my fork.
I had a couple of errors with generating and building that, but for now, it works. I will try to look at the rest tomorrow.

For now, I created my own GitHub Page. I suppose that we will have to change the source codes when merging?

@zsunberg
Copy link
Member Author

If you set it up right, it should automatically create a page at https://juliapomdp.github.io/FiniteHorizonPOMDPs.jl/stable/

@Omastto1
Copy link
Member

Currently, the documentation is set up at https://omastto1.github.io/FiniteHorizonPOMDPs.jl/stable.

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