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.

Sign up for GitHub

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

initial docs website #120

Merged
merged 3 commits into from
Dec 3, 2024
Merged

initial docs website #120

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
38f9d77
website initial
Nov 25, 2024
727aa19
initial
Dec 3, 2024
0d4b1f3
small
Dec 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
initial
  • Loading branch information
Alex Rutherford authored and Alex Rutherford committed Dec 3, 2024
commit 727aa194f43dd8beac5655909a3e300b8d580088
14 changes: 1 addition & 13 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,4 @@ JaxMARL combines ease-of-use with GPU-enabled efficiency, and supports a wide ra
* 8 MARL algorithms, also fully implemented in JAX


## Commands

* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs -h` - Print help message and exit.

## Project layout

mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
More documentation to follow soon!
3 changes: 3 additions & 0 deletions docs/multi_agent_env.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
::: jaxmarl.environments.multi_agent_env.MultiAgentEnv
options:
show_bases: False
11 changes: 9 additions & 2 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,12 @@ theme:
accent: deep orange

plugins:
- search
- mkdocstrings
- search
- mkdocstrings:
handlers:
python:
paths: [../examples,../jaxmarl,..]
options:
show_docstring_examples: true
show_root_heading: false
show_source: False
Loading