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

feat: mkdocs documentation #1052

Open
wants to merge 28 commits into
base: develop
Choose a base branch
from
Open

Conversation

liamclarkza
Copy link
Contributor

Adds mkdocs support for readthedocs. View the current feature branch docs here: https://id-mava.readthedocs.io/en/feat-mkdocs-documentation/

Additionally, the readme has been simplified as things like benchmarks have been moved to the docs pages.

Note: the User Guide and Evaluation pages are currently "in the works" and are not currently displayed on readthedocs (they have been commented out in the mkdocs.yml file)

@sash-a sash-a changed the title Feat/mkdocs documentation feat: mkdocs documentation Mar 5, 2024
@WiemKhlifi WiemKhlifi added the documentation Improvements or additions to documentation label Mar 6, 2024
@RuanJohn RuanJohn mentioned this pull request Mar 11, 2024
@sash-a
Copy link
Contributor

sash-a commented Mar 12, 2024

Something that could be good to add to the sharp bits section is to have a part on how total_timesteps and num_updates interact with each other and why we have both config options

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation size/XL
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants