Skip to content

Commit

Permalink
Fix doc search and warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
apaszke committed Jan 20, 2017
1 parent b740878 commit 58a88d1
Show file tree
Hide file tree
Showing 6 changed files with 51 additions and 42 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ torch/csrc/nn/THNN.cwrap
torch/csrc/nn/THNN.cpp
torch/csrc/nn/THCUNN.cwrap
torch/csrc/nn/THCUNN.cpp
docs/src/**/*
test/data/legacy_modules.t7
test/htmlcov
test/.coverage
Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
sphinx
sphinx_rtd_theme
-e git://github.com/snide/sphinx_rtd_theme.git#egg=sphinx_rtd_theme
2 changes: 2 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,9 @@ def handle_item(fieldarg, content):
if len(fieldtype) == 1 and isinstance(fieldtype[0], nodes.Text):
typename = u''.join(n.astext() for n in fieldtype)
typename = typename.replace('int', 'python:int')
typename = typename.replace('long', 'python:long')
typename = typename.replace('float', 'python:float')
typename = typename.replace('type', 'python:type')
par.extend(self.make_xrefs(self.typerolename, domain, typename,
addnodes.literal_emphasis))
else:
Expand Down
1 change: 0 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,3 @@ Indices and tables

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
1 change: 1 addition & 0 deletions docs/source/torch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -176,3 +176,4 @@ BLAS and LAPACK Operations
.. autofunction:: svd
.. autofunction:: symeig
.. autofunction:: trtrs

86 changes: 46 additions & 40 deletions torch/_torch_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -1465,17 +1465,18 @@
[torch.FloatTensor of size 3x2]
""")

add_docstr(torch._C.geqrf,
"""
""")
# TODO
# add_docstr(torch._C.geqrf,
# """
# """)

add_docstr(torch._C.ger,
"""
""")
# add_docstr(torch._C.ger,
# """
# """)

add_docstr(torch._C.gesv,
"""
""")
# add_docstr(torch._C.gesv,
# """
# """)

add_docstr(torch._C.get_num_threads,
"""
Expand Down Expand Up @@ -1578,9 +1579,10 @@
""")

add_docstr(torch._C.inverse,
"""
""")
# TODO
# add_docstr(torch._C.inverse,
# """
# """)

add_docstr(torch._C.kthvalue,
"""
Expand Down Expand Up @@ -2753,25 +2755,26 @@
""")

add_docstr(torch._C.orgqr,
"""
""")
# TODO
# add_docstr(torch._C.orgqr,
# """
# """)

add_docstr(torch._C.ormqr,
"""
""")
# add_docstr(torch._C.ormqr,
# """
# """)

add_docstr(torch._C.potrf,
"""
""")
# add_docstr(torch._C.potrf,
# """
# """)

add_docstr(torch._C.potri,
"""
""")
# add_docstr(torch._C.potri,
# """
# """)

add_docstr(torch._C.potrs,
"""
""")
# add_docstr(torch._C.potrs,
# """
# """)

add_docstr(torch._C.pow,
"""
Expand Down Expand Up @@ -2921,12 +2924,13 @@
""")

add_docstr(torch._C.pstrf,
"""
""")
# TODO
# add_docstr(torch._C.pstrf,
# """
# """)

add_docstr(torch._C.qr,
"""
"""Computes the QR decomposition of a matrix.
""")

add_docstr(torch._C.rand,
Expand Down Expand Up @@ -3528,13 +3532,14 @@
""")

add_docstr(torch._C.svd,
"""
""")
# TODO
# add_docstr(torch._C.svd,
# """
# """)

add_docstr(torch._C.symeig,
"""
""")
# add_docstr(torch._C.symeig,
# """
# """)

add_docstr(torch._C.t,
"""
Expand Down Expand Up @@ -3844,9 +3849,10 @@
""")

add_docstr(torch._C.trtrs,
"""
""")
# TODO
# add_docstr(torch._C.trtrs,
# """
# """)

add_docstr(torch._C.trunc,
"""
Expand Down

0 comments on commit 58a88d1

Please sign in to comment.