Single file documentation for each model, accompanied by the Documentation overview.

2019-07-05 17:35:26 -04:00
parent 03de9686a7
commit df759114c9
9 changed files with 290 additions and 266 deletions
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -4,16 +4,29 @@ Pytorch-Transformers: The Big & Extending Repository of pretrained Transformers

 .. toctree::
    :maxdepth: 2
+    :caption: Notes

    installation
    usage
-    doc
    examples
    notebooks
    tpu
    cli


+.. toctree::
+    :maxdepth: 2
+    :caption: Package Reference
+
+    model_doc/overview
+    model_doc/bert
+    model_doc/gpt
+    model_doc/transformerxl
+    model_doc/gpt2
+    model_doc/xlm
+    model_doc/xlnet
+
+
 .. image:: https://circleci.com/gh/huggingface/pytorch-pretrained-BERT.svg?style=svg
   :target: https://circleci.com/gh/huggingface/pytorch-pretrained-BERT
   :alt: CircleCI