proper nouns begin with a capital letter, and remove spaces in class name

9 years ago · 7f07e830e2
parent cad67febc1
commit 7f07e830e2
15 changed files with 80 additions and 95 deletions
--- a/doc/source/api.rst
+++ b/doc/source/api.rst
@ -1,4 +1,4 @@
-Api
+API
 ===

 .. doxygenfile:: paddle/api/PaddleAPI.h
--- a/doc/source/cuda/cuda.rst
+++ b/doc/source/cuda/cuda.rst
@ -1,35 +0,0 @@
-Cuda
-====
-
-Dynamic Link Libs
-----------------
-
-hl_dso_loader.h
-```````````````
-.. doxygenfile:: paddle/cuda/include/hl_dso_loader.h
-
-GPU Resources
-------------
-
-hl_cuda.ph
-``````````
-.. doxygenfile:: paddle/cuda/include/hl_cuda.ph
-
-hl_cuda.h
-`````````
-.. doxygenfile:: paddle/cuda/include/hl_cuda.h
-
-CUDA Wrapper
------------
-
-hl_cuda_cublas.h
-````````````````
-.. doxygenfile:: paddle/cuda/include/hl_cuda_cublas.h
-
-hl_cuda_cudnn.h
-```````````````
-.. doxygenfile:: paddle/cuda/include/hl_cuda_cudnn.h
-
-hl_cuda_cudnn.h
-```````````````
-.. doxygenfile:: paddle/cuda/include/hl_cuda_cudnn.ph
--- a/doc/source/cuda/index.rst
+++ b/doc/source/cuda/index.rst
@ -1,10 +1,9 @@
-Cuda
+CUDA
 ====

 .. toctree::
  :maxdepth: 2

-  cuda.rst
  matrix.rst
  nn.rst
  utils.rst
--- a/doc/source/cuda/nn.rst
+++ b/doc/source/cuda/nn.rst
@ -10,10 +10,12 @@ Base
 .. doxygenfile:: paddle/cuda/include/hl_gpu_functions.cuh
 .. doxygenfile:: paddle/cuda/include/hl_activation_functions.h

+
 CNN Related APIs
 ----------------
 .. doxygenfile:: paddle/cuda/include/hl_cnn.h
 .. doxygenfile:: paddle/cuda/include/hl_cuda_cudnn.h
+.. doxygenfile:: paddle/cuda/include/hl_cuda_cudnn.ph

 RNN Related APIs
 ----------------
--- a/doc/source/cuda/utils.rst
+++ b/doc/source/cuda/utils.rst
@ -1,10 +1,29 @@
 Utils
 =====

+Dynamic Link Libs
+-----------------
+.. doxygenfile:: paddle/cuda/include/hl_dso_loader.h
+
+GPU Resources
+-------------
+
+hl_cuda.ph
+``````````
+.. doxygenfile:: paddle/cuda/include/hl_cuda.ph
+
+hl_cuda.h
+`````````
+.. doxygenfile:: paddle/cuda/include/hl_cuda.h
+
 HPPL Base
 ---------
 .. doxygenfile:: paddle/cuda/include/hl_base.h

+CUBLAS Wrapper
+--------------
+.. doxygenfile:: paddle/cuda/include/hl_cuda_cublas.h
+
 Timer
 -----
 .. doxygenfile:: paddle/cuda/include/hl_time.h
--- a/doc/source/gserver/dataproviders.rst
+++ b/doc/source/gserver/dataproviders.rst
@ -3,10 +3,10 @@ Data Providers
 ==============

 DataProviders
-==============
+=============

-Base DataProvider
-----------------
+Base
+----
 ..  doxygenclass:: paddle::DataProvider
    :members:

@ -74,7 +74,7 @@ IPyDataProvider
    :members:

 ProtoDataProvider
-===================
+=================

 ProtoDataProvider
 ----------------
--- a/doc/source/gserver/gradientmachines.rst
+++ b/doc/source/gserver/gradientmachines.rst
@ -2,17 +2,17 @@ Gradient Machines
 =================

 GradientMachine
----------------
+---------------
 ..  doxygenclass:: paddle::GradientMachine
    :members:

 GradientMachineMode
---------------------
+-------------------
 ..  doxygenclass:: paddle::IGradientMachineMode
    :members:

 MultiGradientMachine
----------------------
+--------------------
 ..  doxygenclass:: paddle::MultiGradientMachine
    :members:

@ -22,6 +22,6 @@ TrainerThread
    :members:

 RecurrentGradientMachine
--------------------------
+------------------------
 ..  doxygenclass:: paddle::RecurrentGradientMachine
    :members:
--- a/doc/source/gserver/index.rst
+++ b/doc/source/gserver/index.rst
@ -1,4 +1,4 @@
-Gserver
+GServer
 =======

 .. toctree::
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@ -7,7 +7,7 @@ Source Code Documents
  gserver/index.rst
  trainer.rst
  parameter/index.rst
-  pserver.rst
+  pserver/index.rst
  api.rst
  cuda/index.rst
  math/index.rst
--- a/doc/source/math/vector.rst
+++ b/doc/source/math/vector.rst
@ -22,12 +22,12 @@ GpuVector Template
    :members:

 ParallelCpuVector Template
-```````````````````````````
+``````````````````````````
 ..  doxygenclass:: paddle::ParallelCpuVectorT
    :members:

 ParallelGpuVector Template
-```````````````````````````
+``````````````````````````
 ..  doxygenclass:: paddle::ParallelGpuVectorT
    :members:

--- a/doc/source/pserver/index.rst
+++ b/doc/source/pserver/index.rst
@ -1,4 +1,4 @@
-Pserver
+PServer
 =======

 .. toctree::
--- a/doc/source/pserver/network.rst
+++ b/doc/source/pserver/network.rst
@ -2,26 +2,26 @@ Network
 =======

 SocketServer
-------------
+------------
 ..  doxygenclass:: paddle::SocketServer
    :members:

 SocketWorker
-------------
+------------
 ..  doxygenclass:: paddle::SocketWorker
    :members:

 SocketClient
-------------
+------------
 ..  doxygenclass:: paddle::SocketClient
    :members:

 SocketChannel
--------------
+-------------
 ..  doxygenclass:: paddle::SocketChannel
    :members:

 MessageReader
--------------
+-------------
 ..  doxygenclass:: paddle::MsgReader
    :members:
--- a/doc/source/utils/lock.rst
+++ b/doc/source/utils/lock.rst
@ -1,32 +1,32 @@
 Lock
 ====

-class RWLock
------------
+RWLock
+------
 ..  doxygenclass:: paddle::RWLock
    :members:

-class ReadLockGuard
-------------------
+ReadLockGuard
+-------------
 ..  doxygenclass:: paddle::ReadLockGuard
    :members:

-class SpinLock
--------------
+SpinLock
+--------
 ..  doxygenclass:: paddle::SpinLock
    :members:

-class Semaphore
---------------
+Semaphore
+---------
 ..  doxygenclass:: paddle::Semaphore
    :members:

-class ThreadBarrier
-------------------
+ThreadBarrier
+-------------
 ..  doxygenclass:: paddle::ThreadBarrier
    :members:

-class LockedCondition
---------------------
+LockedCondition
+---------------
 ..  doxygenclass:: paddle::LockedCondition
    :members:
--- a/doc/source/utils/queue.rst
+++ b/doc/source/utils/queue.rst
@ -1,12 +1,12 @@
 Queue
 =====

-class Queue
------------
+Queue
+-----
 ..  doxygenclass:: paddle::Queue
    :members:

-class BlockingQueue 
-------------------
+BlockingQueue 
+-------------
 ..  doxygenclass:: paddle::BlockingQueue 
    :members:
--- a/doc/source/utils/thread.rst
+++ b/doc/source/utils/thread.rst
@ -1,27 +1,27 @@
 Thread
 ======

-class Thread 
------------
+Thread 
+------
 ..  doxygenclass:: paddle::Thread
    :members:

-class ThreadWorker
------------------
+ThreadWorker
+------------
 ..  doxygenclass:: paddle::ThreadWorker
    :members:

-class SyncThreadPool 
--------------------
+SyncThreadPool 
+--------------
 ..  doxygenclass:: paddle::SyncThreadPool 
    :members:
    
-class MultiThreadWorker 
-----------------------
+MultiThreadWorker 
+-----------------
 ..  doxygenclass:: paddle::MultiThreadWorker 
    :members:

-class AsyncThreadPool 
---------------------
+AsyncThreadPool 
+---------------
 ..  doxygenclass:: paddle::AsyncThreadPool
    :members: