Conversation
apaszke
left a comment
There was a problem hiding this comment.
Do we really want to keep compiled docs in the repo? Is there any reason to keep the old docs around?
torch/__init__.py
Outdated
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
torch/__init__.py
Outdated
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
torch/__init__.py
Outdated
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
|
I've kept everything as-is the old I don't think there's any compiled docs in the new |
|
Ah, |
|
Yeah, exactly. There's also automodule and autoclass. The module and class ones have support for auto-including all members, but then you don't have as much control over the ordering (which I think we'll want to do for |
This is the basis Doxygen scaffolding. To build the html documentation, first install doxygen, then: cd torch/csrc/jit/codegen/cuda/docs doxygen fuser.doxygen
This is the basis Doxygen scaffolding. To build the html documentation, first install doxygen, then: cd torch/csrc/jit/codegen/cuda/docs doxygen fuser.doxygen
I've started adding sphix docs. You can build the documentation with:
cd docs pip install -r requirements.txt make clean htmlThere's still a bunch of work to do, including porting over much of the existing documentation, but if you want to get started on documenting the C torch.xxx functions they're listed in
torch/docs.py.We're using Google style Python docstrings because they tend to be nicer to read then pure reStructuredText:
http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
Also worth reading is the Python docstring convention:
https://www.python.org/dev/peps/pep-0257/
Last, a tidbits from Documenting Python: