typehints into description (#19)

1d38afa1 · Ruilong Li(李瑞龙) · GitHub · dbc2181c · 1d38afa1 · 1d38afa1
Unverified Commit 1d38afa1 authored Sep 16, 2022 by Ruilong Li(李瑞龙) Committed by GitHub Sep 16, 2022
Hide whitespace changes
Inline Side-by-side

Showing with 7 additions and 6 deletions

docs/source/conf.py docs/source/conf.py +3 -0

docs/source/index.rst docs/source/index.rst +4 -6

No files found.
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -89,3 +89,6 @@ html_theme_options = {

 # -- Options for EPUB output
 epub_show_urls = "footnote"
+
+# typehints
+autodoc_typehints = "description"
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -14,21 +14,19 @@ Installation:

   $ pip install nerfacc

-
 .. toctree::
   :glob:
   :maxdepth: 1
-   :caption: Example Usages
-
-   examples/*
+   :caption: Python API

+   apis/*

 .. toctree::
   :glob:
   :maxdepth: 1
-   :caption: Python API
+   :caption: Example Usages

-   apis/*
+   examples/*

 .. toctree::
   :maxdepth: 1