Docs layout and navigation changes (#1635)

* Add more detailed navigation for python API * Make the content block a bit wider Signed-off-by: Rafal <[email protected]>
msr-fiddle · Jan 15, 2020 · 3884d77 · 3884d77
1 parent 4ebb558
commit 3884d77
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 3 deletions.
diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html
@@ -28,6 +28,10 @@
     .wy-side-nav-search>div.version {
       color: rgba(0, 0, 0, 0.3)
     }
+
+    .wy-nav-content {
+      max-width: 1000px;
+    }
   </style>
   {% endblock %}
 

diff --git a/docs/api.rst b/docs/api.rst
@@ -3,56 +3,79 @@ Python API
 
 Pipeline
 --------
-
-.. automodule:: nvidia.dali.pipeline
+.. autoclass:: nvidia.dali.pipeline.Pipeline
    :members:
 
 Tensor
 ------
 
+TensorCPU
+^^^^^^^^^
 .. autoclass:: nvidia.dali.backend.TensorCPU
    :members:
    :undoc-members:
 
+TensorGPU
+^^^^^^^^^
 .. autoclass:: nvidia.dali.backend.TensorGPU
    :members:
    :undoc-members:
 
 TensorList
 ----------
 
+TensorListCPU
+^^^^^^^^^^^^^
 .. autoclass:: nvidia.dali.backend.TensorListCPU
    :members:
 
+TensorListGPU
+^^^^^^^^^^^^^
 .. autoclass:: nvidia.dali.backend.TensorListGPU
    :members:
 
 
+
 Types
 -----
 
+Constant
+^^^^^^^^
 .. autoclass:: nvidia.dali.types.Constant
    :members:
 
+
 Enums
 -----
 
+DALIDataType
+^^^^^^^^^^^^
 .. autoclass:: nvidia.dali.types.DALIDataType
    :members:
    :undoc-members:
 
+DALIIterpType
+^^^^^^^^^^^^^
 .. autoclass:: nvidia.dali.types.DALIInterpType
    :members:
    :undoc-members:
 
+DALIImageType
+^^^^^^^^^^^^^
 .. autoclass:: nvidia.dali.types.DALIImageType
    :members:
    :undoc-members:
 
+TensorLayout
+^^^^^^^^^^^^
 .. autoclass:: nvidia.dali.types.TensorLayout
    :members:
    :undoc-members:
 
+PipelineAPIType
+^^^^^^^^^^^^^^^
 .. autoclass:: nvidia.dali.types.PipelineAPIType
    :members:
-   :undoc-members:
+   :undoc-members:
+
+----