Switching docs to markdown only (facebookresearch#3003)

docs/source/agents_list.rst → docs/source/agents_list.md

@@ -1,14 +1,14 @@
-Standard Agents
----------------
+# Standard Agents
 
 ParlAI comes with a wide variety of standardized agents. Some of these are
 common baselines made available for quicker research; some can be made
 state-of-the-art with careful tuning and experimentation. Each of these contains
 a README with examples of usage and description of the agent.
 
-.. toctree::
-   :maxdepth: 1
-   :caption: List of Agents
-   :glob:
+```{toctree}
+:maxdepth: 1
+:caption: List of Agents
+:glob:
 
-   agent_refs/*
+agent_refs/*
+```

docs/source/cli_advanced.md

@@ -0,0 +1,6 @@
+# Advance Scripts
+
+These are the more obscure and advanced scripts in parlai.
+
+```{include} cli_advanced.inc
+```

docs/source/cli_usage.md

@@ -0,0 +1,38 @@
+# Main scripts
+
+This contains the command line usage for each of the standard scripts we
+release. These are each included in `parlai/scripts`, and all may
+be invoked with the "parlai" supercommand.
+
+The parlai supercommand may be invoked from the command line by running
+`parlai` after installing ParlAI. Its default output looks like this:
+
+```none
+usage: parlai [-h] [--helpall] COMMAND ...
+
+       _
+      /")
+     //)
+  ==//'=== ParlAI
+   /
+
+optional arguments:
+  -h, --help               show this help message and exit
+  --helpall                show all commands, including advanced ones.
+
+Commands:
+
+  display_data (dd)        Display data from a task
+  display_model (dm)       Display model predictions.
+  eval_model (em, eval)    Evaluate a model
+  train_model (tm, train)  Train a model
+  interactive (i)          Interactive chat with a model on the command line
+  safe_interactive         Like interactive, but adds a safety filter
+  self_chat                Generate self-chats of a model
+
+The remainder of this page describes each of the commands, their possible arguments,
+and some examples of their usage.
+```
+
+```{include} cli_usage.inc
+```

docs/source/conf.py

@@ -125,9 +125,9 @@
 
 # myst options
 myst_admonition_enable = True
-myst_amsmath_enable = True
+# myst_amsmath_enable = True
 myst_html_img_enable = True
-myst_dmath_enable = True
+# myst_dmath_enable = True
 
 
 # -- Options for HTMLHelp output ------------------------------------------

docs/source/core.md

@@ -0,0 +1,11 @@
+# parlai.core
+
+This contains the full, comprehensive docstrings of all of `parlai.core`,
+which powers the vast majority of ParlAI.
+
+```{toctree}
+:maxdepth: 1
+:glob:
+
+core/*
+```

docs/source/core/agents.md

@@ -0,0 +1,5 @@
+# parlai.core.agents
+```{eval-rst}
+.. automodule:: parlai.core.agents
+  :members:
+```

docs/source/core/build_data.md

@@ -0,0 +1,5 @@
+# parlai.core.build_data
+```{eval-rst}
+.. automodule:: parlai.core.build_data
+  :members:
+```

docs/source/core/dict.md

@@ -0,0 +1,5 @@
+# parlai.core.dict
+```{eval-rst}
+.. automodule:: parlai.core.dict
+  :members:
+```

docs/source/core/loader.md

@@ -0,0 +1,5 @@
+# parlai.core.loader
+```{eval-rst}
+.. automodule:: parlai.core.loader
+  :members:
+```