Skip to content

Sphinx docs #285

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Oct 11, 2017
Merged

Sphinx docs #285

merged 6 commits into from
Oct 11, 2017

Conversation

chsasank
Copy link
Contributor

@chsasank chsasank commented Oct 7, 2017

Fix #284

Idea is to fix the documentation build process of torchvision using sphinx.

Here's how docs will looks like: https://chsasank.github.io/vision/

TODO:

@@ -3,6 +3,7 @@
from torchvision import transforms
from torchvision import utils

__version__ = '0.1.9'

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

@fmassa
Copy link
Member

fmassa commented Oct 7, 2017

I think this looks good, but I have no experience with sphinx so I can't comment on that. I suppose we also need to change something in https://github.com/pytorch/pytorch.github.io ?

@chsasank
Copy link
Contributor Author

chsasank commented Oct 7, 2017

We'll fix pytorch.org/docs later by removing docs/torchvision in pytorch/pytorch.

PIL.Image is renamed to 'PIL Image' because PIL.Image is the module and PIL.Image.Image is the class we are referring but is too long to put in docstrings
chsasank added a commit to chsasank/builder that referenced this pull request Oct 8, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix the documentation/readme
3 participants