Improve docs

yzhangcs · yzhangcs · commit df04a9ecf776 · 2020-11-10T13:55:39.000+08:00
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -3,19 +3,19 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-supar
+SuPar
 =================================
-The :mod:`supar` package provides a collection of state-of-the-art syntactic parsing models with Biaffine Parser as the basic architecture.
+The :mod:`SuPar` package provides a collection of state-of-the-art syntactic parsing models with Biaffine Parser as the basic architecture.
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents
 
    self
-   supar.parsers <parsers>
-   supar.models <models>
-   supar.modules <modules>
-   supar.utils <utils>
+   parsers
+   models
+   modules
+   utils
 
 Indices and tables
 ==================
diff --git a/docs/source/models.rst b/docs/source/models.rst
@@ -1,4 +1,4 @@
-supar.models
+Models
 ==================
 
 .. currentmodule:: supar.models
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
@@ -1,4 +1,4 @@
-supar.modules
+Modules
 ==================
 
 .. currentmodule:: supar.modules
diff --git a/docs/source/parsers.rst b/docs/source/parsers.rst
@@ -1,4 +1,4 @@
-supar.parsers
+Parsers
 ==================
 
 .. currentmodule:: supar.parsers
diff --git a/docs/source/utils.rst b/docs/source/utils.rst
@@ -1,4 +1,4 @@
-supar.utils
+Utils
 ==================
 
 .. currentmodule:: supar.utils
diff --git a/supar/modules/bert.py b/supar/modules/bert.py
@@ -11,6 +11,7 @@ class BertEmbedding(nn.Module):
     A module that directly utilizes the pretrained models in `transformers`_ to produce BERT representations.
     While mainly tailored to provide input preparation and post-processing for the BERT model,
     it is also compatiable with other pretrained language models like XLNet, RoBERTa and ELECTRA, etc.
+
     Args:
         model (str):
             Path or name of the pretrained models registered in `transformers`_, e.g., ``'bert-base-cased'``.
@@ -31,6 +32,7 @@ class BertEmbedding(nn.Module):
         requires_grad (bool):
             If ``True``, the model parameters will be updated together with the downstream task.
             Default: ``False``.
+
     .. _transformers:
         https://github.com/huggingface/transformers
     """

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-supar.models`
	`1`	`+Models`
`2`	`2`	`==================`
`3`	`3`
`4`	`4`	`.. currentmodule:: supar.models`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-supar.modules`
	`1`	`+Modules`
`2`	`2`	`==================`
`3`	`3`
`4`	`4`	`.. currentmodule:: supar.modules`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-supar.parsers`
	`1`	`+Parsers`
`2`	`2`	`==================`
`3`	`3`
`4`	`4`	`.. currentmodule:: supar.parsers`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-supar.utils`
	`1`	`+Utils`
`2`	`2`	`==================`
`3`	`3`
`4`	`4`	`.. currentmodule:: supar.utils`