Skip to content

Start documentation website#540

Merged
mwydmuch merged 10 commits into
Farama-Foundation:masterfrom
mgoulao:master
Jul 17, 2023
Merged

Start documentation website#540
mwydmuch merged 10 commits into
Farama-Foundation:masterfrom
mgoulao:master

Conversation

@mgoulao

@mgoulao mgoulao commented May 1, 2023

Copy link
Copy Markdown
Contributor
  • Add Sphinx docs
  • Move old doc to docs

Preview:
https://mgoulao.github.io/ViZDoom/

What is missing:

  • Add a gif to main page
  • Add a code snippet of gymnasium wrapper

@mgoulao mgoulao marked this pull request as draft May 1, 2023 10:10
@mwydmuch

mwydmuch commented May 2, 2023

Copy link
Copy Markdown
Member

Thank you, @mgoulao. This already looks very good. Are there any other things to do besides the ones on "What is missing" list?

@mgoulao

mgoulao commented May 3, 2023

Copy link
Copy Markdown
Contributor Author

Yes, I think we should try to move the API documentation to the code and use autodoc the retrieve them but this project has a very peculiar code structure and both Python and C++ APIs so I don't know the best approach here.

@mwydmuch mwydmuch marked this pull request as ready for review June 19, 2023 15:28
@mwydmuch mwydmuch changed the title Start documentation website (WIP) Start documentation website Jun 19, 2023
@mwydmuch mwydmuch changed the title (WIP) Start documentation website Start documentation website Jul 17, 2023
@mwydmuch mwydmuch merged commit 0a904ba into Farama-Foundation:master Jul 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants