timer: inherit ModuleDoc
authorSean Cross <sean@xobs.io>
Tue, 24 Sep 2019 06:34:41 +0000 (14:34 +0800)
committerSean Cross <sean@xobs.io>
Tue, 24 Sep 2019 06:34:41 +0000 (14:34 +0800)
With the new ModuleDoc class, we can inherit `ModuleDoc` and
automatically get module-level documentation.

This patch also corrects a typo in `timer` that causes an error in
sphinx.

Signed-off-by: Sean Cross <sean@xobs.io>
litex/soc/cores/timer.py

index 08fc6ee0973abde207679ca405eb8413f7714325..def26cecdfbaeca162ead18d30760e4bfc1a9859 100644 (file)
@@ -8,9 +8,9 @@ from migen import *
 
 from litex.soc.interconnect.csr import *
 from litex.soc.interconnect.csr_eventmanager import *
+from litex.soc.integration.doc import ModuleDoc
 
-
-class Timer(Module, AutoCSR):
+class Timer(Module, AutoCSR, ModuleDoc):
     """Timer
 
     Provides a generic Timer core.
@@ -21,7 +21,7 @@ class Timer(Module, AutoCSR):
     - Periodic: (Re-)Loads itself when value reaches 0.
 
     `en` register allows the user to enable/disable the Timer. When the Timer is enabled, it is
-    automatically loaded with the value of `load' register.
+    automatically loaded with the value of `load` register.
 
     When the Timer reaches 0, it is automatically reloaded with value of `reload` register.